API documentation

Authenticate with an API key or session cookie. Use the endpoints below to manage credentials, bandwidth, and nodes.

Authentication

curl -H "X-API-Key: your_api_key" \
  https://your-domain.com/api/credentials

Proxy usage

# HTTP Proxy
curl -x http://USERNAME:PASSWORD@proxy.host:8888 https://api.ipify.org

# SOCKS5 Proxy
curl --socks5 USERNAME:PASSWORD@proxy.host:1080 https://api.ipify.org

# Country filter (set on credential)
# Credential with countryFilter="US,DE" routes only through US/DE nodes

Endpoints

GET
/api/credentials

List proxy credentials

POST
/api/credentials

Create a new credential

PATCH
/api/credentials/:id

Update credential settings

DELETE
/api/credentials/:id

Delete a credential

GET
/api/bandwidth?days=30

Get bandwidth usage data

POST
/api/nodes/register

Auto-register a proxy node (agent)

POST
/api/nodes/:id/heartbeat

Node heartbeat (agent)

GET
/api/auth/me

Get current user info

Node agent

# Deploy the auto-registration agent on a proxy server
NODE_NAME=us-east-1 \
NODE_HOST=1.2.3.4 \
NODE_COUNTRY=US \
NODE_CITY="New York" \
npm run agent