Skip to main content
GET
Get check quota
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