Skip to main content

API Overview

Proxyon API base URL, authentication flow, and request format.

AI Summary

Get a summary of this page using your preferred AI assistant.

Base URL

All API requests are made to:

Plain Text
1https://api.proxyon.io/v1/

Authentication

The Proxyon API uses a two-step authentication flow:

Step 1: Get Your API Key

Find your API key in Dashboard > Settings.

Step 2: Get a Session Token

Exchange your API key for a session token:

Bash
1curl -X POST https://api.proxyon.io/v1/auth/token \
2  -d "apikey=YOUR_API_KEY"

Response:

JSON
1{
2  "success": true,
3  "result": {
4    "token": "bd2b070a9afbd4d3f824344047df0fe4cc1e6b52...",
5    "expiration": 1696814447
6  }
7}

Step 3: Use the Session Token

Include the token in all subsequent requests via the X-Session-Token header:

Bash
1curl -H "X-Session-Token: YOUR_TOKEN" \
2  https://api.proxyon.io/v1/account/info

Token Expiration

Session tokens expire. Check if your token is still valid:

Bash
1curl -H "X-Session-Token: YOUR_TOKEN" \
2  https://api.proxyon.io/v1/auth/verifyToken

If expired, request a new token using your API key.

Response Format

All responses follow this structure:

Success

JSON
1{
2  "success": true,
3  "result": {
4    // response data
5  }
6}

Error

JSON
1{
2  "success": false,
3  "error": "Error message describing what went wrong"
4}

Available Endpoint Groups

Group Description Key Operations
/auth/* Authentication Get token, verify token
/account/* Account management Balance, transactions, invoices, deposits
/datacenter/* Datacenter proxies (IPv4/IPv6) Order, renew, bind IP, reset, list, stock
/rotating/* IPv6 rotating proxies Order, renew, bind IP, reset, list
/residential/* Residential proxies Order, top up, reset password, stats, list

Common Operations

Check Account Balance

Bash
1curl -H "X-Session-Token: YOUR_TOKEN" \
2  https://api.proxyon.io/v1/account/info

Deposit Funds

Bash
1curl -X POST https://api.proxyon.io/v1/account/deposit \
2  -H "X-Session-Token: YOUR_TOKEN" \
3  -d "paymentmethod=crypto" \
4  -d "amount=50"

Returns a payment URL to complete the deposit.

Order a Datacenter Proxy

Bash
1curl -X POST https://api.proxyon.io/v1/datacenter/order \
2  -H "X-Session-Token: YOUR_TOKEN" \
3  -d "type=ipv4" \
4  -d "country=US" \
5  -d "duration=30" \
6  -d "quantity=10"

Order Residential Bandwidth

Bash
1curl -X POST https://api.proxyon.io/v1/residential/order \
2  -H "X-Session-Token: YOUR_TOKEN" \
3  -d "quantity=10" \
4  -d "resold=false"

Get Formatted Residential Proxy List

Bash
1curl -H "X-Session-Token: YOUR_TOKEN" \
2  "https://api.proxyon.io/v1/residential/SUBSCRIPTION_ID/format?type=rotating&protocol=http&country=us&quantity=10"

Full API Specification

For the complete endpoint reference with all parameters and response schemas, see the Swagger documentation.