Skip to main content
The SOAX API gives you programmatic access to everything you’d otherwise manage in the dashboard: list and inspect your proxy packages, generate ready-to-use connection strings, browse available locations, pull usage analytics, and manage API keys — all without logging in.
The API manages your account. It is separate from the proxy gateway (proxy.soax.com:1337) that carries your actual proxy traffic. You authenticate to the API with an API key (s_live_…); you authenticate to the proxy gateway with a package key (a 10-character password, one per package). See Authentication for the difference.

​
Base URL

All endpoints live under a single base URL and are versioned under /v1:
Requests and responses are JSON over HTTPS. Use paths exactly as documented — the API keys collection paths end with a trailing slash (/v1/api-keys/), and calling them without it triggers a 307 redirect that not every HTTP client follows with the Authorization header intact.

​
Authentication

Every request must carry an API key in the Authorization header:
Keys are created in the dashboard under Settings → API keys and carry scopes that control which endpoints they can call. See Authentication for the full scope reference.

​
Endpoints at a glance

​
Pagination

GET /v1/proxy/packages uses cursor-based pagination. Each page returns has_more and next_cursor; pass next_cursor as the cursor query parameter to fetch the next page, and stop when has_more is false. Other list endpoints return complete lists without pagination.

​
Rate limits

Each API key can make 5 requests per second, and each client IP 500 requests per minute. Exceeding either returns 429. See Rate limits for details and retry guidance.

​
Errors

Errors use conventional HTTP status codes with a JSON body describing the problem. See Error handling for every status code, the response shapes, and how to handle each case.

​
OpenAPI specification

The API is described by an OpenAPI 3.1 specification, useful for generating clients or importing into tools like Postman:

​
Next steps

Quickstart

Create an API key and make your first request in a few minutes.

Authentication

API keys, scopes, package restrictions, and key lifecycle.

Error handling

Status codes, error bodies, and how to handle each.

Rate limits

Limits, the 429 response, and how to check your remaining quota.