Account

Residential account data — traffic, subuser count, hash

Get residential account summary

get

Returns summary for the main residential account — available traffic, subuser count, and account hash.

Authorizations

api_token

AuthorizationstringRequired

API token generated in the MarsProxies dashboard under /settings. Send it as a Bearer token in the Authorization header.

Responses

200

Residential account summary

application/json

Summary of the main residential account.

traffic_availablenumber · floatRequired

Residential traffic currently available, in gigabytes.

Example: 12.5

subusers_countintegerRequired

Number of residential subusers owned by this account.

Example: 4

hashstringRequired

Residential account hash.

Example: A1B2C3D4E5F6G7H8I9J0K1L2M3

401

Missing or invalid API token

application/json

403

Residential API is not enabled for this account

application/json

404

Residential user record not found for this account

application/json

429

Rate limit exceeded

application/json

500

Unknown error

application/json

get/v1/residential/me

cURLPHPPythonNode.jsJavaGoC#

curl --request GET \
  --url https://api.marsproxies.com/v1/residential/me \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "traffic_available": 12.5,
  "subusers_count": 4,
  "hash": "A1B2C3D4E5F6G7H8I9J0K1L2M3"
}