api documentation / proxycheck.io






















Back
Last update: 8th of January 2024
8th of January 2024
Altered the text that appears beneath the test console to better explain that the address results shown are not live and may differ from live API results.
25th of September 2023
Added a new flag: p to the documentation, which allows you to deactivate the pretty-print output of the API (aka the results appear as a single line) which is more appropriate for efficient bandwidth use when only machines will be reading the API output.
27th of June 2023
The node.js library on this page was changed to a new one utilising typescript written by neo773.
13th of June 2023
The ruby gem made by Jonathan De Jong was updated to support our v2 API and so the library table of features was updated to reflect this change.
12th of June 2023
The cache time displayed for queries was altered, it used to be 10 to 60 seconds, it is now 10 seconds to 10 minutes. The cache time is per-node and depends on how many queries you're sending per second with the higher the volume of queries you make resulting in a longer cache time.
26th of April 2023
Altered all references to requests per second (RPS) in the documentation as the limits have been raised from 125 to 200 RPS.
25th of January 2023
Altered the test console to support currency data which has been introduced in the latest version of the API. Added several currency related variables to the Custom Rules documentation.
14th of January 2023
Added a new section called Geography Data which introduces our new resources URL for gaining metadata relevent to our API results. Added references to currency data which is new in the API when using the &asn=1 flag, references included a new flag to disable currency data if desired.
4th of January 2023
Altered the server-side url example to include a warning about sending email addresses in URLs due to character conflicts, recommending instead to send them using the POST method.
29th of October 2022
Added references to postcodes which were added to the API output and also to custom rules for use in conditions and as variables. Altered the variable name for operators from %OPERATOR_NAME% to %OPERATORNAME%, both ways will function but the corrected name is more in-line with our design guidelines. Added postcodes to the test console.
31st of August 2022
Added references to timezones which were added to the API output and also to custom rules for use in conditions and as variables.
12th of August 2022
Added references to the new Dashboard API per-second request limits (2 per second / 20 per 10 seconds) to the Dashboard API tab.
13th of June 2022
Added a new query flag &short=1 which compresses the API result by removing one array depth from the result, this makes the API easier to parse in some languages. Updated the query flags section of the API documentation to enable a new VPN flag mode, &vpn=3 which displays both proxy and vpn results side-by-side instead of overwriting the VPN check result with a Proxy result.
1st of June 2022
Updated the query flags section of the API documentation to show support for &vpn=2 which allows you to disable proxy checks and only perform VPN checking.
29th of May 2022
Added a new Custom Lists sectioin to the Dashboard API tab. Removed the Whitelist/Blacklist documentation from the Dashboard API tab.