Get check quota
curl --request GET \
--url https://api.proxyjam.com/public/v1/ip-check/quota \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.proxyjam.com/public/v1/ip-check/quota"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.proxyjam.com/public/v1/ip-check/quota', 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.proxyjam.com/public/v1/ip-check/quota",
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: <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.proxyjam.com/public/v1/ip-check/quota"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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.proxyjam.com/public/v1/ip-check/quota")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.proxyjam.com/public/v1/ip-check/quota")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"entitled": 123,
"used": 123,
"free_available": 123,
"price": "<string>",
"currency": "<string>"
}IP reputation
Get check quota
How many free IP checks are left, and what a paid one costs.
GET
/
ip-check
/
quota
Get check quota
curl --request GET \
--url https://api.proxyjam.com/public/v1/ip-check/quota \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.proxyjam.com/public/v1/ip-check/quota"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.proxyjam.com/public/v1/ip-check/quota', 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.proxyjam.com/public/v1/ip-check/quota",
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: <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.proxyjam.com/public/v1/ip-check/quota"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<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.proxyjam.com/public/v1/ip-check/quota")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.proxyjam.com/public/v1/ip-check/quota")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"entitled": 123,
"used": 123,
"free_available": 123,
"price": "<string>",
"currency": "<string>"
}Every proxy order you have been delivered grants one free
IP check. This endpoint reports how many of those
you have earned, how many you have spent, and the price once they run out —
so you can show the cost before the check is submitted.
Response
integer
Free checks earned in total, one per delivered proxy order.
integer
Free checks already spent. This can exceed
entitled if an order later left
the delivered state; the count of what was spent does not change retroactively.integer
Free checks left, never below zero.
string
What a check costs once the free ones are gone, as a decimal string.
string
Always
USD. Checks are debited from the USD wallet and no conversion is
performed, so a balance held only in another currency will not pay for one.A check can still cost nothing when
free_available is 0: a recent result
for the same address is reused free of charge, and that cannot be known until
the address is given.Example
curl https://api.proxyjam.com/public/v1/ip-check/quota \
-H "X-API-Key: pj_AbCdEf..."
from proxyjam import ProxyJamClient
with ProxyJamClient(api_key="pj_live_...") as proxyjam:
quota = proxyjam.ip_check.quota()
print(quota.free_available, quota.price_as_decimal())