Skip to main content
GET
/
api
/
reseller
/
v1
/
bandwidth
Get bandwidth info
curl --request GET \
  --url https://www.eclipseproxy.com/api/reseller/v1/bandwidth
{
  "bandwidthBalance": 123,
  "storeName": "<string>",
  "storeCode": "<string>",
  "subuserCount": 123,
  "totalAllocated": 123,
  "createdAt": "<string>"
}
Retrieve your bandwidth pool balance and account overview.

Authentication

Requires a reseller API key. Pass it as Authorization: Bearer YOUR_API_KEY or X-API-Key: YOUR_API_KEY. See Reseller overview.

Response

bandwidthBalance
number
Available bandwidth in MB.
storeName
string
Human-readable store name.
storeCode
string
Unique store identifier.
subuserCount
number
Total subusers created.
totalAllocated
number
Total bandwidth allocated across all subusers (MB).
createdAt
string
Account creation timestamp (ISO 8601).

Example response

{
  "status": "success",
  "message": "OK",
  "messageCode": "OK",
  "data": {
    "bandwidthBalance": 1000,
    "storeName": "My Store",
    "storeCode": "MYSTORE",
    "subuserCount": 5,
    "totalAllocated": 500,
    "createdAt": "2026-01-15T10:30:00Z"
  }
}

Errors

  • 401 UNAUTHORIZED: missing or invalid API key
  • 403 NOT_RESELLER: account is not a reseller