> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roundproxies.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Basics

> How the Roundproxies Reseller API works and how to check your data pool.

As a Roundproxies reseller you hold a prepaid pool of residential data, measured in GB. Against that pool you create **sub-users** — username/password accounts on our residential gateway, each with its own traffic limit — and hand those credentials to your customers.

Your customers never need to touch this API. They just use the proxy credentials you give them.

|              |                                |
| ------------ | ------------------------------ |
| **Base URL** | `https://api.roundproxies.com` |
| **Format**   | JSON in, JSON out              |

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

<Note>
  Everything below can also be done from your reseller dashboard. The API exists so you can automate it from your own systems.
</Note>

## 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**.
* Every data figure you **send** is in whole **GB**, where 1 GB = 1024³ bytes (`1,073,741,824`).

```js theme={null}
const BYTES_PER_GB = 1024 ** 3;
const toGB = (bytes) => (bytes / BYTES_PER_GB).toFixed(2);
```

<Tip>
  Format displayed values from the raw byte fields (`rawUsed`, `rawTotal`, `dataBytes`) with the 1024³ divisor, so a 2 GB account displays as "2.00 GB".
</Tip>

## Your account

### GET /reseller/account

Returns your pool balance and how much of it is already committed to sub-users.

```bash cURL theme={null}
curl https://api.roundproxies.com/reseller/account \
  -H "x-reseller-key: $KEY"
```

**200 OK**

```json theme={null}
{
  "account": {
    "id": "...",
    "name": "Your Company",
    "email": "you@example.com",
    "apiKeyPrefix": "rsl_30a3298b",
    "data": {
      "allocatedBytes": 10737418240,
      "remainingBytes": 6442450944,
      "assignedBytes": 4294967296
    },
    "createdAt": "..."
  },
  "subUserCount": 2
}
```

### Response Fields

| Field                  | Type   | Description                                                                |
| ---------------------- | ------ | -------------------------------------------------------------------------- |
| `account.apiKeyPrefix` | string | The visible prefix of your active key, for identifying which key is in use |
| `data.allocatedBytes`  | number | Total data you've purchased, lifetime                                      |
| `data.remainingBytes`  | number | Unassigned data you can still put on sub-users                             |
| `data.assignedBytes`   | number | Data already assigned to sub-users                                         |
| `subUserCount`         | number | How many sub-users you've created                                          |

To increase your allocation, contact your account manager.

## Next steps

* [Authentication](/reseller/authentication) — your API key and how to rotate it
* [Sub-Users](/reseller/sub-users) — create, list, and top up customer accounts
* [Proxy Access](/reseller/proxy-access) — the gateway format your customers connect with
* [Error Handling](/reseller/error-handling) — error reference and retry behavior