- Residential data — a pool of GB, measured against your own residential purchases. You spend it by creating sub-users: username/password accounts on our residential gateway, each with its own traffic limit, which you hand to your customers.
- Static proxies — datacenter (shared IPs) and ISP (dedicated IPs). You hold a concurrent capacity limit per product and draw allocations of IPs against it.
Send
Content-Type: application/json on every request that has a body.
Everything below can also be done from your reseller dashboard. The API exists so you can automate it from your own systems.
Where your data pool comes from
Your residential allocation is self-funding: it is your own purchased residential data, plus any optional top-ups we grant you.purchasedBytes— residential data you bought through the dashboard like any other customer. Kept in sync automatically; buy more and your reseller allocation grows with it.grantedBytes— optional manual top-ups from us (compensation, negotiated bonuses). Not required for the pool to work.
remainingBytes simply goes negative, recording how far ahead of your purchases you’ve assigned. There is no “not enough data” error.
Units
The API is asymmetric about units, and it’s the most common thing to get wrong:- Every data figure in responses is in bytes (
dataBytes,remainingBytes,rawUsed). - Every data figure you send is in whole GB, where 1 GB = 1024³ bytes (
1,073,741,824).
Your account
GET /reseller/account
Returns your pool, where it came from, and your static proxy capacity.cURL
Response Fields
To increase your allocation, buy residential data from your dashboard. To raise your static proxy capacity, contact your account manager.
Live usage
AddincludeUsage=true to fold in live consumption counters from the gateway:
cURL
retailUsage is null when the account has no retail package, or when its gateway lookup failed. Treat null as “unavailable”, never as zero.
includeUsage=true performs one gateway lookup per sub-user (batched), so it’s noticeably slower. Without the flag the endpoint makes no gateway calls at all. For trends over time use Usage History instead — it’s served from stored history and costs nothing.Next steps
- Authentication — your API key, dashboard-token access, and rotation
- Sub-Users — create, list, adjust, and delete customer accounts
- Static Proxies — allocate and release datacenter and ISP IPs
- Usage History — consumption time series
- Proxy Access — the gateway format your customers connect with
- Error Handling — error reference and retry behavior