Skip to main content
GET
https://api.clearproxy.io
/
me
Get User Info
curl --request GET \
  --url https://api.clearproxy.io/me \
  --header 'X-API-Key: <x-api-key>'
{
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "checks": 5000,
    "balance_breakdown": {
      "root_balance": 3000,
      "temp_balance": 2000
    }
  },
  "history": [...],
  "usage_last_30_days": [...]
}

​
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)

​
Example Request

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

​
Response

​
user
object
User account information
​
history
array
Array of recent check operations
​
usage_last_30_days
array
Usage statistics for the last 30 days
{
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "checks": 5000,
    "balance_breakdown": {
      "root_balance": 3000,
      "temp_balance": 2000
    }
  },
  "history": [...],
  "usage_last_30_days": [...]
}