Get User Info
curl --request GET \
--url https://api.clearproxy.io/me \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://api.clearproxy.io/me"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://api.clearproxy.io/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clearproxy.io/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.clearproxy.io/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.clearproxy.io/me")
.header("X-API-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clearproxy.io/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"user": {
"email": "hello@clearproxy.io",
"checks_used": 1,
"remaining_checks": 10938392,
"subscription_detail": {
"UnlimitedPro": false
},
"breakdown": {
"root_balance": 10938392,
"temp_balance": 0
}
},
"history": [],
"usage_last_30_days": []
}
Rest API
Get User Info
Get account information, quota, and usage history
GET
/
me
Get User Info
curl --request GET \
--url https://api.clearproxy.io/me \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://api.clearproxy.io/me"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://api.clearproxy.io/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clearproxy.io/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.clearproxy.io/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.clearproxy.io/me")
.header("X-API-Key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clearproxy.io/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"user": {
"email": "hello@clearproxy.io",
"checks_used": 1,
"remaining_checks": 10938392,
"subscription_detail": {
"UnlimitedPro": false
},
"breakdown": {
"root_balance": 10938392,
"temp_balance": 0
}
},
"history": [],
"usage_last_30_days": []
}
Authentication
string
required
Your ClearProxy API key (format: clearpx_yourkey)
string
Bearer token (format: Bearer clearpx_yourkey)
Example Request
curl https://api.clearproxy.io/me \
-H "X-API-Key: clearpx_yourkey"
Response
object
User account information
Show properties
Show properties
string
User ID
string
Email address
integer
Total number of checks used
integer
Total remaining checks
object
array
Array of recent check operations
array
Usage statistics for the last 30 days
{
"user": {
"email": "hello@clearproxy.io",
"checks_used": 1,
"remaining_checks": 10938392,
"subscription_detail": {
"UnlimitedPro": false
},
"breakdown": {
"root_balance": 10938392,
"temp_balance": 0
}
},
"history": [],
"usage_last_30_days": []
}
⌘I

