Usage API - Roundproxies Docs

Use this endpoint to check how much residential data you have used and how much is left on your plan.

Method	Endpoint	Description
`GET`	`https://api.roundproxies.com/traffic/residential`	Your plan status and data usage

Authentication

Send your API key in the x-api-key header. You can find it in your dashboard.

Get Usage

Node.js
Python
cURL

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

import os
import requests

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

curl https://api.roundproxies.com/traffic/residential \
  -H "x-api-key: $RP_API_KEY"

Response

200 OK

{
  "active": true,
  "planData": 10,
  "usage": {
    "used": "1.5 GB",
    "total": "10 GB",
    "rawUsed": 1500000000,
    "rawTotal": 10000000000
  }
}

Field	Type	Description
`active`	boolean	Whether your plan is active
`planData`	number	Your plan’s data allowance in GB
`usage.used`	string	Data used, in readable form
`usage.total`	string	Data allowance, in readable form
`usage.rawUsed`	number	Data used in bytes
`usage.rawTotal`	number	Data allowance in bytes

Residential Basics

Proxy format, ports and authentication.

Error Handling

What each proxy error means and how to fix it.

Last modified on October 14, 2026