Get User Information

GET /me
Api key auth Bearer auth

Retrieve user account information including:

  • Current quota balance
  • Last 30 scan history with secure download links
  • Daily usage statistics for the past 30 days

Responses

  • 200 application/json

    User information retrieved successfully

    Hide response attributes Show response attributes object
    • user object
      Hide user attributes Show user attributes object
      • id string(uuid)
      • email string(email)
      • checks integer

        Remaining quota balance

    • history array[object]
      Hide history attributes Show history attributes object
      • id integer
      • total_checked integer
      • total_working integer
      • result_url string(uri) | null

        Secure URL with token (expires in 12 hours)

      • proxy_type string

        Values are http, socks4, or socks5.

      • scanned_at string(date-time)
    • history_count integer
    • usage_last_30_days array[object]
      Hide usage_last_30_days attributes Show usage_last_30_days attributes object
      • day string(date)
      • total_checked integer
  • 401 application/json

    Unauthorized - Invalid or missing API key

    Hide response attributes Show response attributes object
    • error string
    • message string
  • 500 application/json

    Internal Server Error

    Hide response attributes Show response attributes object
    • error string
    • message string
GET /me 
curl \
 --request GET 'https://api.clearproxy.io/me' \
 --header "X-API-Key: $API_KEY"
Response examples (200) 
{
  "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&expires=1234567890",
      "proxy_type": "http",
      "scanned_at": "2025-10-06T10:30:00.000Z"
    }
  ],
  "history_count": 30,
  "usage_last_30_days": [
    {
      "day": "2025-10-06",
      "total_checked": 1500
    }
  ]
}
Response examples (401) 
{
  "error": "API key is required",
  "message": "Please provide API key in X-API-Key header or Authorization header"
}
{
  "error": "Invalid API key",
  "message": "The provided API key is not valid"
}
Response examples (500) 
{
  "error": "Internal server error",
  "message": "An unexpected error occurred"
}