For the complete documentation index, see llms.txt. This page is also available as Markdown.

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
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
get/v1/residential/me

Last updated

Was this helpful?