Box’a’Fox
API referenceProxy lists

Data balance for residential

GET
/v1/residential/summary

bytes_used is measured by the gateway.

Authorization

ApiKey
headerX-API-Key<token>

prx_live_<40 base62>

Response Body

OK

application/json
  1. response
data*
message*string

Human-readable status, safe to show to end users.

curl -X GET "https://example.com/v1/residential/summary"
{  "data": {    "bytes_left": 0,    "bytes_purchased": 0,    "bytes_used": 0,    "frozen_until": "2019-08-24T14:15:22Z",    "last_usage_at": "2019-08-24T14:15:22Z",    "network": "residential",    "proxy_user_ids": [      "string"    ],    "requests_30d": 0,    "status": "none",    "valid_until": "2019-08-24T14:15:22Z"  },  "message": "OK"}

Data balance for mobile GET

bytes_used is measured by the gateway.

Generate mobile proxy strings GET

Returns ready-to-use proxy strings. Nothing is created: a sticky session starts with its first connection. Unknown alias → 400 validation_error with details.field; a combination the network does not support → 400 bad_target. Counts as one request for rate limiting whatever the count.