Skip to main content
GET
/
api
/
user-api
/
bandwidth
Check remaining bandwidth
curl --request GET \
  --url https://www.eclipseproxy.com/api/user-api/bandwidth \
  --header 'Authorization: <authorization>'
{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "coreResidential": {
      "remaining": 123,
      "unit": "<string>",
      "asOf": "<string>"
    },
    "residential": {
      "remaining": 123,
      "unit": "<string>",
      "asOf": "<string>"
    }
  }
}
Returns your remaining Residential bandwidth in MB.

​
Headers

​
Authorization
string
required
Bearer <YOUR_API_TOKEN>: see Get / reset API token.

​
Response

​
status
string
required
"success" on success.
​
message
string
Human-readable confirmation.
​
data
object
required

​
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.