Archonum API Documentation

Archonum is a residential proxy service. There are two ways to use it:

  • REST API — request connection details for a proxy via HTTPS, then use them with any client.
  • Direct gateway — point any HTTP or SOCKS5 client at stagegw.archonum.com with your username + token.

Interactive reference: Swagger UI · ReDoc · OpenAPI YAML

Authentication

Every request requires an API token. Sign in and copy yours from the API Key page.

REST API: pass it in the Authorization header.

Authorization: Token YOUR_API_TOKEN

Gateway: use your username as the proxy username and the token as the proxy password.

REST API

Base URL: https://stage.archonum.com/api/v1

GET /api/v1/proxies/

Returns connection details for an available proxy.

Query params: country (ISO 2-letter, e.g. US), session (any string, pins same IP for ~10 min).

curl -H "Authorization: Token YOUR_TOKEN" \
  "https://stage.archonum.com/api/v1/proxies/?country=US&session=mysession"

Response includes host, http_port, socks_port, username, password, connection_string, curl_http, curl_socks5.

GET /api/v1/browsers/

Returns credentials for a managed browser session. Costs 5 MB of credits up front.

curl -H "Authorization: Token YOUR_TOKEN" \
  "https://stage.archonum.com/api/v1/browsers/?country=US"

GET /api/v1/credits/

Current credit balance, in MB.

curl -H "Authorization: Token YOUR_TOKEN" \
  "https://stage.archonum.com/api/v1/credits/"

GET /api/v1/health/

Public liveness probe. No authentication required.

curl "https://stage.archonum.com/api/v1/health/"

Direct gateway usage

You don't have to call the REST API for every request. Point any HTTP/SOCKS5 client at the gateway directly.

Host
stagegw.archonum.com
HTTP port
10080
SOCKS5 port
10443
CDP port
10900

Username format (gateway parses suffixes):

{username}[-country_{CC}][-session_{ID}]

HTTP proxy

curl -x http://USER:TOKEN@stagegw.archonum.com:10080 https://ip-api.com/json

SOCKS5 proxy

curl --socks5 USER:TOKEN@stagegw.archonum.com:10443 https://ip-api.com/json

Country filtering

Append -country_XX (lowercase ISO 2-letter) to your username.

curl -x http://USER-country_us:TOKEN@stagegw.archonum.com:10080 https://ip-api.com/json

Sticky sessions

Append -session_ID to your username (any alphanumeric string). Same ID returns the same exit IP for ~10 minutes.

curl --socks5 USER-country_us-session_abc123:TOKEN@stagegw.archonum.com:10443 https://ip-api.com/json

Billing & limits

  • Credits are denominated in MB of bandwidth.
  • /api/v1/proxies/ returns connection info for free; bandwidth is metered as you actually use the proxy.
  • /api/v1/browsers/ deducts 5 MB up front per request.
  • When your balance hits zero, in-flight proxy connections are dropped.
  • Track usage on the History page.

Errors

Status Meaning
401Missing or invalid API token.
402Insufficient credits.
404No proxies/credentials match the requested filters.

Versioning

The current version is v1. Always include the version prefix in your URLs (/api/v1/...).

Unversioned /api/... paths still resolve to v1 today as a backward-compatibility alias, but new integrations should use the versioned form so a future v2 won't break them.