Skip to main content
GET
/
v4
/
account
/
{subAccountId}
/
residential
/
overview
Residential overview
curl --request GET \
  --url https://api.proxyscrape.com/v4/account/{subAccountId}/residential/overview \
  --header 'api-token: <api-key>'
{
  "plan": "<string>",
  "bandwidth_used": 123,
  "bandwidth_limit": 123,
  "status": "<string>"
}

Authorizations

api-token
string
header
required

API key. Create and manage keys at /v4/account/api-keys or in the dashboard.

Path Parameters

subAccountId
string<uuid>
required

Response

200 - application/json

Residential overview

plan
string
bandwidth_used
integer
bandwidth_limit
integer
status
string