Skip to main content
POST
/
check
Check Proxies
curl --request POST \
  --url https://api.clearproxy.io/check \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "proxies": [
    {}
  ],
  "jobId": "<string>",
  "region": "<string>",
  "type": "<string>",
  "timeout": 123,
  "customUrls": [
    {}
  ],
  "customUrls[].url": "<string>",
  "customUrls[].requiredStatusCodes": [
    {}
  ],
  "customUrls[].requiredText": "<string>",
  "customUrls[].caseSensitive": true
}
'
{
  "summary": {
    "total_working": 123,
    "countries": {}
  },
  "metadata": {
    "user": {
      "subscription_detail": {
        "UnlimitedPro": true,
        "unlimited_expired_at": "<string>"
      }
    }
  },
  "result_url": "<string>"
}

​
Authentication

​
X-API-Key
string
required
Your ClearProxy API key (format: clearpx_yourkey)
Alternatively, you can use Bearer token authentication:
​
Authorization
string
Bearer token (format: Bearer clearpx_yourkey)

​
Request Body

​
proxies
array
required
Array of proxy addresses
​
jobId
string
Optional client-side generated job ID for real-time progress tracking via WebSockets
​
region
string
Region code (default: us1)
​
type
string
Proxy type: http, socks4, socks5 (default: http)
​
timeout
integer
Timeout in ms (1000-20000)
​
customUrls
array
Array of custom URLs to validate working proxies against

​
Custom URL Parameters

​
customUrls[].url
string
required
Target URL to test proxies against
​
customUrls[].requiredStatusCodes
array
HTTP status codes to accept (default: [200])
​
customUrls[].requiredText
string
Text that must appear in response body
​
customUrls[].caseSensitive
boolean
Case-sensitive text matching (default: false)

​
Example Request

curl -X POST https://api.clearproxy.io/check \
  -H "X-API-Key: clearpx_yourkey" \
  -H "Content-Type: application/json" \
  -d '{
    "proxies": ["1.2.3.4:8080", "user:pass@5.6.7.8:3128"],
    "region": "sg1",
    "type": "http",
    "timeout": 2000,
    "jobId": "my_unique_job_id_123"
  }'

​
Example with Custom URL Validation

curl -X POST https://api.clearproxy.io/check \
  -H "X-API-Key: clearpx_yourkey" \
  -H "Content-Type: application/json" \
  -d '{
    "proxies": ["1.2.3.4:8080"],
    "customUrls": [
      {
        "url": "https://discord.com",
        "requiredStatusCodes": [200, 301, 302]
      }
    ]
  }'

​
Response

​
summary
object
Summary of check results
​
metadata
object
Detailed metadata about the request
​
result_url
string
URL to download full results