Skip to main content
GET
Check remaining bandwidth
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

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.