Basics

The Reseller API covers two products:

Residential data: a pool of GB based on your own residential purchases. You use it by creating sub-users, which are username and password accounts on our residential proxy, each with its own data limit. You give these to your customers.
Static proxies: datacenter (shared IPs) and ISP (dedicated IPs). You have a capacity limit for each and take allocations of IPs from it.

Your customers never use this API. They only use the proxy credentials you give them.


Base URL	`https://api.roundproxies.com`
Format	JSON requests and responses

Send Content-Type: application/json with every request that has a body.

You can do all of this in your reseller dashboard too. The API is there so you can automate it.

Where Your Data Comes From

Your residential pool is your own purchased residential data, plus any extra data we grant you.

Formula

allocatedBytes = purchasedBytes + grantedBytes
remainingBytes = allocatedBytes - assignedBytes

purchasedBytes: residential data you bought in the dashboard. It stays in sync automatically, so when you buy more, your pool grows.
grantedBytes: extra data we add by hand, for example as compensation or an agreed bonus. Your pool works without it.

The pool is tracked, not enforced. Creating a sub-user never fails because you are out of data. Instead, remainingBytes goes negative to show how much more you have assigned than you bought. There is no “not enough data” error.

A negative remainingBytes means it is time to buy more residential data. Nothing gets blocked, so keep an eye on it yourself.

Units

This is the most common thing to get wrong:

Data in responses is always in bytes (dataBytes, remainingBytes, rawUsed).
Data you send is always in GB, with up to two decimals (0.5, 0.01). 1 GB is 1024³ bytes (1,073,741,824). Fractions are stored as whole bytes, so 0.01 GB becomes 10,737,418 bytes.

Node.js

const BYTES_PER_GB = 1024 ** 3;
const toGB = (bytes) => (bytes / BYTES_PER_GB).toFixed(2);

To show values to customers, convert the byte fields with 1024³. A 2 GB account then shows as “2.00 GB”.

Your Account

GET /reseller/account

Returns your pool, where it comes from, and your static proxy capacity.

Node.js
Python
cURL

Node.js

const res = await fetch("https://api.roundproxies.com/reseller/account", {
  headers: { "x-reseller-key": process.env.RESELLER_KEY },
});
console.log(await res.json());

Python

import os
import requests

res = requests.get(
    "https://api.roundproxies.com/reseller/account",
    headers={"x-reseller-key": os.environ["RESELLER_KEY"]},
)
print(res.json())

cURL

curl https://api.roundproxies.com/reseller/account \
  -H "x-reseller-key: $RESELLER_KEY"

Response

{
  "account": {
    "id": "...",
    "name": "Acme",
    "email": "acme@example.com",
    "apiKeyPrefix": "rsl_a1b2c3d4",
    "data": {
      "allocatedBytes": 107374182400,
      "remainingBytes": 64424509440,
      "assignedBytes": 42949672960,
      "purchasedBytes": 96636764160,
      "grantedBytes": 10737418240
    },
    "proxies": {
      "datacenter": { "limit": 100, "used": 13 },
      "isp": { "limit": 20, "used": 0 }
    },
    "createdAt": "..."
  },
  "subUserCount": 8
}

Field	Type	Description
`account.apiKeyPrefix`	string	The start of your active key, so you can tell which key is in use
`data.allocatedBytes`	number	`purchasedBytes + grantedBytes`
`data.purchasedBytes`	number	Residential data you bought
`data.grantedBytes`	number	Extra data we granted you
`data.assignedBytes`	number	Data currently assigned to sub-users
`data.remainingBytes`	number	`allocated - assigned`. Can be negative if you assigned more than you have
`proxies.<product>.limit`	number	How many IPs you can hold at once for `datacenter` or `isp`
`proxies.<product>.used`	number	IPs currently in active allocations
`subUserCount`	number	Number of sub-users you created

To grow your pool, buy residential data in the dashboard. To raise your static proxy capacity, contact your account manager.

Live Usage

Add includeUsage=true to include live usage from the proxy network:

cURL

curl "https://api.roundproxies.com/reseller/account?includeUsage=true" \
  -H "x-reseller-key: $RESELLER_KEY"

Response

{
  "usage": { "rawUsed": 1288490188, "rawTotal": 6442450944, "failedLookups": 0 },
  "retailUsage": { "rawUsed": 0, "rawTotal": 5368709120 }
}

Field	Description
`usage`	Usage added up across all your sub-users
`usage.failedLookups`	Sub-users whose usage couldn’t be looked up. They are left out of the totals, so any value above zero means the totals are incomplete
`retailUsage`	Live usage of your own residential package, which your pool is based on. It is kept separate so each used and total pair stays meaningful

retailUsage is null when you have no residential package or its lookup failed. Treat null as “unavailable”, not as zero.

includeUsage=true looks up every sub-user, so the request is noticeably slower. Without it, the endpoint is fast. For usage over time, use Usage History instead, which is served from stored data.

Next Steps

Authentication: your API key, using a dashboard token, and key rotation
Sub-Users: create, list, change and delete customer accounts
Static Proxies: allocate and release datacenter and ISP IPs
Usage History: usage over time
Proxy Access: how your customers connect
Targeting Options: countries, states, cities and ASNs you can target
Error Handling: errors and when to retry

Getting Started

Residential Proxies

ISP Proxies

Datacenter Proxies

Reseller

Where Your Data Comes From

Units

Your Account

GET /reseller/account

Response

Live Usage

Next Steps