API Reference

Integrate VeProxy services into your applications with our comprehensive API

Authentication

All API requests require authentication using an API key. You can generate your API key from the dashboard.

API Key Format

API keys are in the format of a 64-character hexadecimal string.

Authentication Header

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Proxy Endpoints

List Proxies

Get a list of all your proxies

GET /v1/proxies

Request

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.veproxy.com/v1/proxies

Response

{  
  "success": true,
  "data": [
    {
      "id": "proxy_123",
      "type": "residential",
      "ip": "192.168.1.1",
      "port": 8080,
      "username": "user123",
      "password": "pass123",
      "country": "US",
      "city": "New York",
      "created_at": "2025-01-01T00:00:00Z",
      "expires_at": "2025-12-31T23:59:59Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 10
  }
}

Create Proxy

Create a new proxy

POST /v1/proxies

Request Body

{  
  "type": "residential",
  "country": "US",
  "city": "New York",
  "quantity": 5
}

Response

{  
  "success": true,
  "data": [
    {
      "id": "proxy_124",
      "type": "residential",
      "ip": "192.168.1.2",
      "port": 8081,
      "username": "user124",
      "password": "pass124",
      "country": "US",
      "city": "New York",
      "created_at": "2025-01-01T00:00:00Z",
      "expires_at": "2025-12-31T23:59:59Z"
    }
  ]
}

Account Management

Get Account Balance

Check your current account balance

GET /v1/account/balance

Response

{  
  "success": true,
  "data": {
    "balance": 100.50,
    "currency": "USDT"
  }
}

Usage Statistics

Get Usage Stats

View your proxy usage statistics

GET /v1/stats/usage

Response

{  
  "success": true,
  "data": {
    "total_requests": 10000,
    "total_bandwidth": "5.2 GB",
    "daily_stats": [
      {
        "date": "2025-01-01",
        "requests": 1000,
        "bandwidth": "0.5 GB"
      }
    ]
  }
}

Error Codes

Code Message Description
400 Bad Request Invalid request parameters
401 Unauthorized Invalid or missing API key
403 Forbidden Insufficient permissions
404 Not Found Resource not found
500 Internal Server Error Server-side error

Ready to Integrate?

Start building with our API today and unlock the full potential of VeProxy services