API overview
REST endpoints for provisioning, usage and billing.
Everything the dashboard does is available over REST at api.wproxy.io. The API is for managing your account — creating sub-users, reading usage, adjusting limits. It is not in the data path; proxy traffic always goes through the gateways.
| Resource | Path | Purpose |
|---|---|---|
| Proxy users | /v1/proxy-users | Create, list, update and disable sub-credentials |
| Usage | /v1/usage | Traffic and request counts, grouped and filtered |
| Limits | /v1/limits | Daily, monthly and spend ceilings |
| IPs | /v1/ips | Allocated ISP and dedicated addresses |
| Network | /v1/network | Live pool sizes, countries, cities and ASNs |
| Billing | /v1/billing | Balance, invoices and payment methods |
| Subscriptions | /v1/subscriptions | Plans, renewals and cancellation |
Conventions
- JSON in, JSON out. Send Content-Type: application/json on writes.
- Timestamps are RFC 3339 in UTC.
- Traffic is reported in bytes; the dashboard converts for display.
- List endpoints paginate with limit and cursor, returning next_cursor when more data exists.
- Errors return a machine-readable code alongside a human-readable message.
422 Unprocessable Entity
{
"error": {
"code": "invalid_country",
"message": "'xx' is not a country we serve. See /v1/network/countries.",
"field": "allow.countries[0]"
},
"request_id": "req_01J9K2M4XQ"
}Quote the request id
Every response carries a request_id header. Including it in a support ticket lets us pull the exact trace rather than guessing from timestamps.
Something inaccurate?Tell support