Proxio API

The Proxio API is a single, coherent control-plane REST API. It covers the day-to-day work: list your services, mint proxy credentials, generate ready-to-use proxy lists, read usage, place orders and renewals, and receive signed webhooks when things change. A handful of account operations stay in the dashboard, listed under what the API does not cover.

It is built to be predictable. One base URL, one authentication scheme, one response envelope, one error taxonomy, cursor pagination on every list that can grow, documented rate limits, idempotent writes, and an OpenAPI 3.1 document you can feed straight into codegen.

Base URL

Every endpoint lives under a single host and version prefix:

https://dashboard.proxio.net/api/v1

All requests are HTTPS only, send and receive application/json (UTF-8), and carry your API key in the Authorization header. The one documented exception is GET /services/{id}/proxy-list with format=txt or format=csv, which returns text/plain or text/csv.

Endpoint paths in these docs (for example GET /services) are written relative to that base URL; code samples build full URLs from a BASE constant. The discovery route is a GET on the base URL itself.

The envelope at a glance

Every successful response wraps its payload in a data field, with an optional meta object that always carries a request_id and, for paginated lists, a next_cursor:

{
  "data": { "id": "clpkg_2a9x", "category": "RESIDENTIAL", "status": "active" },
  "meta": { "request_id": "req_8Ke2jP4mQ" }
}

Every error uses the same envelope in reverse, with a stable machine-readable code, a human message, a deep link to the docs, and the request_id to quote to support:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "quantity_gb must be an integer >= 1.",
    "doc_url": "https://docs.proxio.net/docs/api/errors#validation_error",
    "request_id": "req_8Ke2jP4mQ",
    "details": [{ "field": "quantity_gb", "issue": "too_small", "min": 1 }]
  }
}

See Errors for the complete catalog and Pagination for the cursor model.

Use with an AI assistant

These docs are built to be handed straight to an AI coding assistant. Point it at the machine-readable sources below and ask it to write the integration, the whole API surface is available in a form an LLM can ingest in one fetch.

Give your assistant one of these URLs and a plain-English goal. A prompt like this is usually enough:

Here is the Proxio API spec: https://dashboard.proxio.net/api/v1/openapi.json
And the full docs: https://docs.proxio.net/llms-full.txt

Write a Python client that:
- authenticates with my pxo_ key from the PROXIO_API_KEY env var
- generates 500 sticky US residential proxy lines and rotates to a fresh
  session every 100 requests
- honors 429s using the Retry-After header

Use the documented endpoints and the { data, meta } / { error } envelope exactly.

Why this API

What the API does not cover

Some account operations live only in the dashboard. There is no /v1 endpoint for any of these:

Everything else in the dashboard, including wallet top-ups, API key management, and the auto-renewal toggle on a service, has an API equivalent.

Start here

Conventions