> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eclipseproxy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check remaining bandwidth

> GET /api/user-api/bandwidth: returns your remaining Residential GB

Returns your remaining Residential bandwidth in MB.

## Headers

<ParamField header="Authorization" type="string" required>
  `Bearer <YOUR_API_TOKEN>`: see [Get / reset API token](/api/authentication).
</ParamField>

## Response

<ResponseField name="status" type="string" required>
  `"success"` on success.
</ResponseField>

<ResponseField name="message" type="string">
  Human-readable confirmation.
</ResponseField>

<ResponseField name="data" type="object" required>
  <Expandable title="data properties">
    <ResponseField name="coreResidential" type="object" required>
      <Expandable title="coreResidential properties">
        <ResponseField name="remaining" type="number">
          Remaining MB on the current Residential system. For all users.
        </ResponseField>

        <ResponseField name="unit" type="string">
          Always `"MB"` currently.
        </ResponseField>

        <ResponseField name="asOf" type="string">
          ISO 8601 timestamp when the value was computed.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="residential" type="object">
      <Expandable title="residential properties">
        <ResponseField name="remaining" type="number">
          Remaining MB on the legacy Residential system. Only present if your account predates the system migration.
        </ResponseField>

        <ResponseField name="unit" type="string">
          Always `"MB"` currently.
        </ResponseField>

        <ResponseField name="asOf" type="string">
          ISO 8601 timestamp.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

## Example response

```json theme={"dark"}
{
  "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](/api/authentication).
* **5xx**: retry with backoff.