API documentation

A REST API for provisioning and managing proxies programmatically is on our roadmap. This page describes the planned shape of that API so integration partners can plan ahead — endpoints below are not yet live.

Authentication

Requests will be authenticated with an API key generated from your dashboard, sent as a bearer token:

Authorization: Bearer {api_key}

Planned endpoints

GET /v1/proxies — list proxies currently assigned to your account.

POST /v1/orders — purchase a new plan by ID.

GET /v1/orders/{'{id}'} — check order and provisioning status.

GET /v1/usage — bandwidth and request usage for the current billing period.

Example response

{
  "data": [
    { "ip": "203.0.113.10", "port": 8080, "type": "residential", "country": "US" }
  ]
}

Want early access when this ships? Get in touch.