OpenAPI
The Proxio API ships an OpenAPI 3.1 document at https://dashboard.proxio.net/api/v1/openapi.json. Import it into Postman or Insomnia, or generate a typed client with openapi-generator.
Proxio publishes a single OpenAPI 3.1 document describing the entire v1 surface. It's the machine-readable companion to these docs: point your tools at it to get a ready-made API collection or a typed client.
https://dashboard.proxio.net/api/v1/openapi.jsonThe document is public (no authentication needed) and cacheable for an hour. It
includes component schemas for the response envelope, errors, byte quantities,
services, credentials, usage, orders, wallet transactions, webhooks, and
locations, plus the bearerAuth security scheme. Its info.description embeds
the stability policy verbatim, so the contract travels
with anything you generate.
The spec is canonical
Where an example in these docs and the OpenAPI document ever disagree, the OpenAPI document wins, it's the single source of truth for the exact shapes.
Import into Postman
Import the URL
In Postman, choose Import, then the Link tab, and paste
https://dashboard.proxio.net/api/v1/openapi.json. Postman generates a collection with
every endpoint, grouped by resource.
Set the base URL and key
Add a collection variable for the base URL (https://dashboard.proxio.net/api/v1) and set
collection-level authorization to Bearer Token with your pxo_… key. Every
request inherits it.
Send a request
Open GET /account and hit Send to confirm the collection and your key
work end to end.
Import into Insomnia
In Insomnia, choose Import, then From URL, and paste the spec URL.
Insomnia builds a request collection from the document. Add your pxo_… key as a
Bearer token in the collection's authentication settings.
Generate a client
Feed the document to any OpenAPI 3.1 generator to get a typed client in your language. For example, with openapi-generator:
openapi-generator-cli generate \
-i https://dashboard.proxio.net/api/v1/openapi.json \
-g python \
-o ./proxio-client-pythonopenapi-generator-cli generate \
-i https://dashboard.proxio.net/api/v1/openapi.json \
-g typescript-fetch \
-o ./proxio-client-tsBecause the error taxonomy is a closed catalog, you can map
each code onto a typed exception in your generated client and branch on it
directly.
Related pages
API Changelog
Additive-tagged changes to the Proxio API. Under the v1 stability policy, new fields, endpoints, events, and error codes ship continuously without breaking existing clients. Describes the current v1 surface.
Targeting & Username Syntax
The master reference for Proxio Residential proxies, covering how the user:pass@host:port connection string works and how to chain country, state, city, sticky-session and smart-retry parameters directly inside the username.