Box’a’Fox
API referenceProxy lists

Generate mobile proxy strings

GET
/v1/mobile/list

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.

Authorization

ApiKey
headerX-API-Key<token>

prx_live_<40 base62>

Query Parameters

count?integer
Formatint64
Range1 <= value <= 1000
Default100
proxy_user_id?string

UUID or username; default user when omitted. Must be active.

session?string
Default"sticky"
Value in"sticky""rotating"
ttl?string

1m–24h, sticky only.

Match^[0-9]+[mhd]$
Default"10m"
country?string

ISO-2 lowercase.

Length2 <= length <= 2
state?string

Residential only, not with city.

city?string

Needs country.

asn?integer

Needs country.

Formatint64
zip?string

Mobile only, needs country.

os?string

Residential only.

Value in"windows""android""ios""mac"
format?string
Default"standard"
Value in"standard""http""https""socks5""socks5h"

Response Body

OK

application/json
  1. response
data*array<string>|null
message*string
meta*
curl -X GET "https://example.com/v1/mobile/list"
{  "data": [    "string"  ],  "message": "OK",  "meta": {    "count": 0,    "format": "standard",    "network": "residential",    "proxy_user_id": "c84ff33e-5958-4495-8f67-4340e0393ba5"  }}

Data balance for residential GET

bytes_used is measured by the gateway.

Generate residential 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.