Check remaining bandwidth

GEThttps://www.eclipseproxy.com/api/user-api/bandwidthBearer auth

Returns your remaining Residential bandwidth in MB.

Example request

curl -X GET "https://www.eclipseproxy.com/api/user-api/bandwidth" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Headers

Authorizationheaderstringrequired

Bearer <YOUR_API_TOKEN>: see Get / reset API token.

Response

statusstringrequired

"success" on success.

messagestring

Human-readable confirmation.

dataobjectrequired

data properties

coreResidentialobjectrequired

coreResidential properties

remainingnumber

Remaining MB on the current Residential system. For all users.

unitstring

Always "MB" currently.

asOfstring

ISO 8601 timestamp when the value was computed.

residentialobject

residential properties

remainingnumber

Remaining MB on the legacy Residential system. Only present if your account predates the system migration.

unitstring

Always "MB" currently.

asOfstring

ISO 8601 timestamp.

Example response

{
  "status": "success",
  "message": "Bandwidth data retrieved successfully",
  "data": {
    "coreResidential": {
      "remaining": 5321.4,
      "unit": "MB",
      "asOf": "2026-06-01T00:00:00Z"
    },
    "residential": {
      "remaining": 100.3,
      "unit": "MB",
      "asOf": "2026-06-01T00:00:00Z"
    }
  }
}

What this doesn't cover

ISP IPs: time-limited (30 days per IP), not bandwidth-metered
Datacenter plans: also time-limited, no bandwidth metering

Common use cases

Pre-flight check before kicking off a long scrape
Monitoring dashboards in your own tools
Auto-topup triggers: alert when remaining drops below a threshold

Errors

401: token invalid or missing. See Authentication.
5xx: retry with backoff.