Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
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
}
'import requests
url = "https://api.clearproxy.io/check"
payload = {
"proxies": [{}],
"jobId": "<string>",
"region": "<string>",
"type": "<string>",
"timeout": 123,
"customUrls": [{}],
"customUrls[].url": "<string>",
"customUrls[].requiredStatusCodes": [{}],
"customUrls[].requiredText": "<string>",
"customUrls[].caseSensitive": True
}
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
proxies: [{}],
jobId: '<string>',
region: '<string>',
type: '<string>',
timeout: 123,
customUrls: [{}],
'customUrls[].url': '<string>',
'customUrls[].requiredStatusCodes': [{}],
'customUrls[].requiredText': '<string>',
'customUrls[].caseSensitive': true
})
};
fetch('https://api.clearproxy.io/check', 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/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'proxies' => [
[
]
],
'jobId' => '<string>',
'region' => '<string>',
'type' => '<string>',
'timeout' => 123,
'customUrls' => [
[
]
],
'customUrls[].url' => '<string>',
'customUrls[].requiredStatusCodes' => [
[
]
],
'customUrls[].requiredText' => '<string>',
'customUrls[].caseSensitive' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clearproxy.io/check"
payload := strings.NewReader("{\n \"proxies\": [\n {}\n ],\n \"jobId\": \"<string>\",\n \"region\": \"<string>\",\n \"type\": \"<string>\",\n \"timeout\": 123,\n \"customUrls\": [\n {}\n ],\n \"customUrls[].url\": \"<string>\",\n \"customUrls[].requiredStatusCodes\": [\n {}\n ],\n \"customUrls[].requiredText\": \"<string>\",\n \"customUrls[].caseSensitive\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clearproxy.io/check")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"proxies\": [\n {}\n ],\n \"jobId\": \"<string>\",\n \"region\": \"<string>\",\n \"type\": \"<string>\",\n \"timeout\": 123,\n \"customUrls\": [\n {}\n ],\n \"customUrls[].url\": \"<string>\",\n \"customUrls[].requiredStatusCodes\": [\n {}\n ],\n \"customUrls[].requiredText\": \"<string>\",\n \"customUrls[].caseSensitive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clearproxy.io/check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"proxies\": [\n {}\n ],\n \"jobId\": \"<string>\",\n \"region\": \"<string>\",\n \"type\": \"<string>\",\n \"timeout\": 123,\n \"customUrls\": [\n {}\n ],\n \"customUrls[].url\": \"<string>\",\n \"customUrls[].requiredStatusCodes\": [\n {}\n ],\n \"customUrls[].requiredText\": \"<string>\",\n \"customUrls[].caseSensitive\": true\n}"
response = http.request(request)
puts response.read_body{
"summary": {
"total_working": 123,
"countries": {}
},
"metadata": {
"user": {
"subscription_detail": {
"UnlimitedPro": true,
"unlimited_expired_at": "<string>"
}
}
},
"result_url": "<string>"
}Check proxies using JSON format with optional custom URL validation
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
}
'import requests
url = "https://api.clearproxy.io/check"
payload = {
"proxies": [{}],
"jobId": "<string>",
"region": "<string>",
"type": "<string>",
"timeout": 123,
"customUrls": [{}],
"customUrls[].url": "<string>",
"customUrls[].requiredStatusCodes": [{}],
"customUrls[].requiredText": "<string>",
"customUrls[].caseSensitive": True
}
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
proxies: [{}],
jobId: '<string>',
region: '<string>',
type: '<string>',
timeout: 123,
customUrls: [{}],
'customUrls[].url': '<string>',
'customUrls[].requiredStatusCodes': [{}],
'customUrls[].requiredText': '<string>',
'customUrls[].caseSensitive': true
})
};
fetch('https://api.clearproxy.io/check', 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/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'proxies' => [
[
]
],
'jobId' => '<string>',
'region' => '<string>',
'type' => '<string>',
'timeout' => 123,
'customUrls' => [
[
]
],
'customUrls[].url' => '<string>',
'customUrls[].requiredStatusCodes' => [
[
]
],
'customUrls[].requiredText' => '<string>',
'customUrls[].caseSensitive' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clearproxy.io/check"
payload := strings.NewReader("{\n \"proxies\": [\n {}\n ],\n \"jobId\": \"<string>\",\n \"region\": \"<string>\",\n \"type\": \"<string>\",\n \"timeout\": 123,\n \"customUrls\": [\n {}\n ],\n \"customUrls[].url\": \"<string>\",\n \"customUrls[].requiredStatusCodes\": [\n {}\n ],\n \"customUrls[].requiredText\": \"<string>\",\n \"customUrls[].caseSensitive\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clearproxy.io/check")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"proxies\": [\n {}\n ],\n \"jobId\": \"<string>\",\n \"region\": \"<string>\",\n \"type\": \"<string>\",\n \"timeout\": 123,\n \"customUrls\": [\n {}\n ],\n \"customUrls[].url\": \"<string>\",\n \"customUrls[].requiredStatusCodes\": [\n {}\n ],\n \"customUrls[].requiredText\": \"<string>\",\n \"customUrls[].caseSensitive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clearproxy.io/check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"proxies\": [\n {}\n ],\n \"jobId\": \"<string>\",\n \"region\": \"<string>\",\n \"type\": \"<string>\",\n \"timeout\": 123,\n \"customUrls\": [\n {}\n ],\n \"customUrls[].url\": \"<string>\",\n \"customUrls[].requiredStatusCodes\": [\n {}\n ],\n \"customUrls[].requiredText\": \"<string>\",\n \"customUrls[].caseSensitive\": true\n}"
response = http.request(request)
puts response.read_body{
"summary": {
"total_working": 123,
"countries": {}
},
"metadata": {
"user": {
"subscription_detail": {
"UnlimitedPro": true,
"unlimited_expired_at": "<string>"
}
}
},
"result_url": "<string>"
}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"
}'
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]
}
]
}'
