REST API

X-API-Key: clearpx_yourkey

Authorization: Bearer clearpx_yourkey

https://api.clearproxy.io

POST /check

{
  "proxies": ["1.2.3.4:8080", "user:pass@5.6.7.8:3128"],
  "region": "us1",
  "type": "http",
  "timeout": 5000
}

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": "us1",
    "type": "http",
    "timeout": 5000
  }'

POST /check-raw?region=us1&type=http&timeout=5000

1.2.3.4:8080
user:pass@5.6.7.8:3128
9.10.11.12:1080:user2:pass2

curl -X POST "https://api.clearproxy.io/check-raw?region=us1&type=http" \
  -H "X-API-Key: clearpx_yourkey" \
  -H "Content-Type: text/plain" \
  --data-binary @proxies.txt

GET /me

curl https://api.clearproxy.io/me \
  -H "X-API-Key: clearpx_yourkey"

{
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "user@example.com",
    "checks": 5000
  },
  "history": [
    {
      "id": 123,
      "total_checked": 1000,
      "total_working": 450,
      "result_url": "https://content.clearproxy.io/result/abc123.json?token=xyz",
      "proxy_type": "http",
      "scanned_at": "2025-10-06T10:30:00.000Z"
    }
  ],
  "usage_last_30_days": [
    {
      "day": "2025-10-06",
      "total_checked": 1500
    }
  ]
}

GET /regions

curl https://api.clearproxy.io/regions

{
  "regions": [
    {
      "code": "us1",
      "name": "Washington DC, USA",
      "endpoints": 16
    },
    {
      "code": "sg1",
      "name": "Singapore",
      "endpoints": 16
    }
  ],
  "default": "us1"
}

GET /health

curl https://api.clearproxy.io/health

{
  "summary": {
    "total_working": 2331,
    "countries": {
      "United States": 150,
      "Germany": 100
    },
    "anonymity_levels": {
      "elite": 200,
      "anonymous": 150,
      "transparent": 100
    },
    "top_isps": {
      "Digital Ocean": 50,
      "Amazon AWS": 45
    }
  },
  "metadata": {
    "user": {
      "email": "user@example.com",
      "checks_used": 100000,
      "remaining_checks": 4000
    },
    "region_used": "us1",
    "region_name": "US, Washington",
    "proxy_type": "http",
    "timeout_used": "5000ms",
    "total_checked": 100000,
    "processing_time": "12.32s"
  },
  "result_url": "https://content.clearproxy.io/result/abc123.json?token=xyz"
}

{
  "proxy": {
    "host": "192.0.2.100",
    "port": 8080,
    "hasAuth": true,
    "username": "myuser",
    "password": "mypassword"
  },
  "status": "working",
  "statusCode": 200,
  "responseTime": "150 ms",
  "anonymity": "elite",
  "origin": "203.0.113.1",
  "country": "United States",
  "location": "New York",
  "isp": "Example ISP Inc.",
  "asn": 64512,
  "coordinates": {
    "lat": 40.7128,
    "lon": -74.006
  }
}

{
  "error": "Invalid region",
  "available_regions": ["us1", "sg1", "uk1"]
}

{
  "error": "Invalid API key",
  "message": "The provided API key is not valid"
}

{
  "error": "Insufficient Checks",
  "message": "You are trying to use 1000 Checks but you only have 500 remaining",
  "required": 1000,
  "available": 500,
  "shortfall": 500
}

{
  "message": "Route /check only accept POST Method"
}

1.1.1.1:8080

user:pass@1.1.1.1:8080

1.1.1.1:8080:user:pass