Proxycheck.io

https://proxycheck.io/api
Admin
Proxycheck.io is an IP and email address verification API that detects proxies, VPNs, residential...
Tokens:13,877
Snippets:151
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Multiple Address Checking Examples

Source: https://proxycheck.io/api

Examples showing how to format multiple addresses for GET and POST requests.

```text
GET Example: http://proxycheck.io/v2/37.60.48.2,47.70.58.3,john.smith@example.com  
POST Example: ips=37.60.48.2,47.70.58.3,john.smith@example.com
```

--------------------------------

### Perform a basic API query

Source: https://proxycheck.io/api

Example of a standard GET request to the proxycheck.io API.

```http
http://proxycheck.io/v2/john.smith@gmail.com?key=######-######-######-######
```

--------------------------------

### Account Usage API Response Example

Source: https://proxycheck.io/api

Example JSON response for account usage statistics.

```json
{
    "Burst Tokens Available": 1,
    "Burst Token Allowance": 1,
    "Queries Today": "255",
    "Daily Limit": "1000",
    "Queries Total": "98523",
    "Plan Tier": "Free"
}
```

--------------------------------

### Tagging API Requests

Source: https://proxycheck.io/api

Examples of how to pass a tag to the API via GET or POST methods to track detections in the dashboard.

```http
http://proxycheck.io/v3/37.60.48.2?tag=Account%20Signup%20Page
```

```http
tag=Account Signup Page
```

--------------------------------

### Query Volume API Response Example

Source: https://proxycheck.io/api

Example JSON response for historical query volume data.

```json
{
    "2025-09-07": {
        "total_queries": 55115,
        "positive_queries": 7535,
        "negative_queries": 47547,
        "refused_queries": 0,
        "proxy": 99,
        "vpn": 7490,
        "compromised": 1345,
        "scraper": 2,
        "tor": 0,
        "hosting": 7494,
        "disposable_email": 1,
        "reusable_email": 33,
        "custom_rule": 0,
        "blacklisted": 0
    }
}
```

--------------------------------

### API response example

Source: https://proxycheck.io/api

A sample JSON response returned by the API for a query.

```json
{
    "status": "ok",
    "john.smith@gmail.com": {
        "disposable": "no"
    }
}
```

--------------------------------

### Comprehensive Query Flag Example

Source: https://proxycheck.io/api

A request demonstrating the use of multiple query flags to retrieve detailed information.

```http
http://proxycheck.io/v2/37.60.48.2?key=111111-222222-333333-444444&vpn=1&asn=1&risk=1&port=1&seen=1&days=7&tag=msg
```

--------------------------------

### Tag Export API Response Example

Source: https://proxycheck.io/api

Example JSON response structure for the tag export endpoint.

```json
{
    "www.example.com\/wp-comments-post.php": {
        "types": {
            "total": 11,
            "proxy": 4
            "vpn": 4
            "rule": 3
        },
        "addresses": {
            "149.28.76.201": 4,
            "87.107.18.84": 4,
            "62.210.83.206": 3
        }
    },
    "www.example.com\/wp-login.php?action=register": {
        "types": {
            "total": 10,
            "proxy": 7
            "vpn": 3
        },
        "addresses": {
            "196.247.18.72": 2,
            "186.65.118.151": 2,
            "149.28.76.201": 2,
            "185.119.255.159": 2,
            "185.162.235.44": 2
        }
    }
}
```

--------------------------------

### Perform API Query

Source: https://proxycheck.io/api

Example URL structure for querying the ProxyCheck v3 API with an email address.

```http
http://proxycheck.io/v3/john.smith@gmail.com?key=######-######-######-######
```

--------------------------------

### GET /v2/{address}

Source: https://proxycheck.io/api

Check an IP or email address for proxy, VPN, or risk status using a GET request.

```APIDOC
## GET /v2/{address}

### Description
Check a single IP address or email address for proxy, VPN, or risk status.

### Method
GET

### Endpoint
http://proxycheck.io/v2/{address}

### Parameters
#### Path Parameters
- **address** (string) - Required - The IPv4, IPv6, or email address to check.

#### Query Parameters
- **key** (string) - Optional - Your API key to increase daily query limits.
- **vpn** (integer) - Optional - VPN check flag (0, 1, 2, or 3).
- **risk** (integer) - Optional - Enable risk scoring.
- **asn** (integer) - Optional - Enable ASN information.
- **port** (integer) - Optional - Enable port information.
- **seen** (integer) - Optional - Enable last seen information.
- **days** (integer) - Optional - Number of days for seen history.
- **tag** (string) - Optional - Custom tag for the request.
```

--------------------------------

### GET /dashboard/export/detections/

Source: https://proxycheck.io/api

Retrieves a list of recent positive proxy and VPN detections from the user's dashboard.

```APIDOC
## GET /dashboard/export/detections/

### Description
Exports recent positive proxy and VPN detections. The endpoint has a rate limit of 2 requests per second.

### Method
GET

### Endpoint
https://proxycheck.io/dashboard/export/detections/

### Parameters
#### Query Parameters
- **json** (integer) - Required - Set to 1 to receive JSON response.
- **key** (string) - Required - Your proxycheck.io API key.
- **limit** (integer) - Optional - Number of entries to return (default 100).
- **offset** (integer) - Optional - Offset for pagination.
- **filter** (string) - Optional - Search term to filter logs (e.g., IP address or custom tag).

### Response
#### Success Response (200)
- **time formatted** (string) - Human-readable timestamp of the detection.
- **time raw** (string) - Unix timestamp of the detection.
- **address** (string) - The IP address detected.
- **detection type** (string) - The type of detection (e.g., vpn).
- **answering node** (string) - The node that performed the detection.
- **tag** (string) - Custom tag associated with the detection.
```

--------------------------------

### Check a single IP address via GET

Source: https://proxycheck.io/api

Perform a basic IP address check using a GET request with an API key.

```text
http://proxycheck.io/v3/37.60.48.2?key=111111-222222-333333-444444
```

--------------------------------

### GET /v3/{address}

Source: https://proxycheck.io/api

Perform a check on a single IP or email address using a GET request.

```APIDOC
## GET /v3/{address}

### Description
Check a single IP address or email address for proxy or disposable status.

### Method
GET

### Endpoint
http://proxycheck.io/v3/{address}

### Parameters
#### Path Parameters
- **address** (string) - Required - The IP address (IPv4/IPv6) or email address to check.

#### Query Parameters
- **key** (string) - Optional - Your API key to increase daily query limits.
- **node** (integer) - Optional - Set to 1 to view the server node that processed the query.
- **days** (float) - Optional - Restrict proxy search to a specific time range in days (0.01 to 60).
- **tag** (string) - Optional - A custom tag for the request.

### Request Example
http://proxycheck.io/v3/37.60.48.2?key=111111-222222-333333-444444&days=7&tag=msg
```

--------------------------------

### Example of Custom Variable Substitution

Source: https://proxycheck.io/api

Shows a successful replacement of the %COUNTRY% variable with the actual country name in the API response.

```json
{
    "status": "ok",
    "39.137.69.6": {
        "asn": "AS38019",
        "provider": "tianjin Mobile Communication Company Limited",
        "continent": "Asia",
        "country": "China",
        "latitude": 34.7725,
        "longitude": 113.7266,
        "isocode": "CN",
        "proxy": "yes",
        "type": "VPN",
        "last seen human": "22 minutes, 47 seconds ago",
        "last seen unix": "1564236260",
        "Factoid": "The great wall of China is 13,170 miles long"
    },
    "query time": "0.003s"
}
```

--------------------------------

### Custom List API Response

Source: https://proxycheck.io/api

Example JSON response returned after performing an action on a custom list.

```json
{
    "status": "ok",
    "message": "List has been added to successfully."
}
```

--------------------------------

### Check an email address via GET

Source: https://proxycheck.io/api

Perform an email address check using a GET request. Note that using POST is recommended for emails to avoid issues with special characters.

```text
http://proxycheck.io/v3/john.smith@example.com?key=111111-222222-333333-444444
```

--------------------------------

### Operator Section Response

Source: https://proxycheck.io/api

Example of the operator object, which provides details about VPN or proxy services associated with an IP address.

```json
"operator": {
    "name": "IVPN",
    "url": "https://www.ivpn.net/",
    "anonymity": "high",
    "popularity": "medium",
    "services": [
      "datacenter_vpns"
    ],
    "protocols": [
        "WireGuard",
        "OpenVPN",
        "IPSec",
        "IKEv2"
    ],
    "policies": {
        "ad_filtering": true,
        "free_access": false,
        "paid_access": true,
        "port_forwarding": false,
        "logging": false,
        "anonymous_payments": true,
        "crypto_payments": true,
        "traceable_ownership": true
    },
    "additional_operators": null
}
```

--------------------------------

### CORS Update Response

Source: https://proxycheck.io/api

Example JSON response returned after successfully updating origin domains.

```json
{
  "success": "Your origins have been updated.",
  "origin_count": 5
}
```

--------------------------------

### Network Section Response

Source: https://proxycheck.io/api

Example of the network object returned for an IP address, showing standard fields like ASN, hostname, and provider.

```json
"network": {
    "asn": "AS16509",
    "range": "98.75.0.0/16",
    "hostname": "db1-production-newyork-dc-2.company.net",
    "provider": "Amazon.com, Inc.",
    "organisation": "Amazon.com, Inc.",
    "type": "Hosting"
}
```

--------------------------------

### GET /v3/{address}

Source: https://proxycheck.io/api

Performs a reputation check on a given email address or IP address.

```APIDOC
## GET /v3/{address}

### Description
Performs a reputation check on a provided email address or IP address to determine if it is disposable, a proxy, or associated with hosting services.

### Method
GET

### Endpoint
http://proxycheck.io/v3/{address}

### Parameters
#### Path Parameters
- **address** (string) - Required - The email address or IP address to check.

#### Query Parameters
- **key** (string) - Required - Your API authentication key.

### Request Example
http://proxycheck.io/v3/john.smith@gmail.com?key=######-######-######-######

### Response
#### Success Response (200)
- **status** (string) - The status of the request (e.g., "ok").
- **{address}** (object) - The result object containing details about the queried address.

#### Response Example
{
  "status": "ok",
  "john.smith@gmail.com": {
    "disposable": "no"
  }
}
```

--------------------------------

### Example of Unresolved Custom Variable

Source: https://proxycheck.io/api

Shows the output when the required data for a variable was not requested, leaving the placeholder unchanged.

```json
{
    "status": "ok",
    "39.137.69.6": {
        "proxy": "yes",
        "type": "VPN",
        "last seen human": "22 minutes, 47 seconds ago",
        "last seen unix": "1564236260",
        "Factoid": "The great wall of %COUNTRY% is 13,170 miles long"
    },
    "query time": "0.003s"
}
```

--------------------------------

### GET /v2/{address}

Source: https://proxycheck.io/api

Perform a lookup on an IP address or email address to check for proxy, VPN, or other risk factors.

```APIDOC
## GET /v2/{address}

### Description
Perform a lookup on an IP address or email address to check for proxy, VPN, or other risk factors.

### Method
GET

### Endpoint
/v2/{address}

### Parameters
#### Path Parameters
- **address** (string) - Required - The IP address or email address to check.

#### Query Parameters
- **key** (string) - Required - Your API key.
- **ver** (string) - Optional - Override the API version (e.g., &ver=10-October-2025).
- **risk** (integer) - Optional - Set to 1 or 2 to include risk score and attack history.
- **days** (integer) - Optional - The range of days for attack history (used with risk=2).
```

--------------------------------

### Custom API Output Field Example

Source: https://proxycheck.io/api

Example of an API response containing a custom field 'Elephant' with the value 'Tusk' added via a rule output modifier.

```json
{
    "status": "ok",
    "39.137.69.6": {
        "asn": "AS38019",
        "provider": "tianjin Mobile Communication Company Limited",
        "continent": "Asia",
        "country": "China",
        "latitude": 34.7725,
        "longitude": 113.7266,
        "isocode": "CN",
        "proxy": "yes",
        "type": "VPN",
        "last seen human": "22 minutes, 47 seconds ago",
        "last seen unix": "1564236260",
        "Elephant": "Tusk"
    },
    "query time": "0.003s"
}
```

--------------------------------

### API Flag Usage Examples

Source: https://proxycheck.io/api

Commonly used flags for configuring API responses, including node identification, result compression, formatting, and time restrictions.

```text
&node=0 &node=1
```

```text
&short=0 &short=1
```

```text
&p=0
&p=1
```

```text
&days=7
```

```text
&tag=_text_
```

```text
&ver=_date_
```

```text
&ver=24-June-2026 or &ver=11-February-2026
```

--------------------------------

### GET /dashboard/rules/[action]/[rule_id]

Source: https://proxycheck.io/api

View, enable, or disable custom rules.

```APIDOC
## GET /dashboard/rules/[action]/[rule_id]

### Description
Perform actions on a specific custom rule identified by ID or name.

### Method
GET (or POST for name-based targeting)

### Endpoint
https://proxycheck.io/dashboard/rules/[action]/[rule_id]

### Parameters
#### Path Parameters
- **action** (string) - Required - The action to perform (print, enable, disable).
- **rule_id** (string) - Optional - The ID of the rule.

#### Query Parameters
- **key** (string) - Required - Your API key.

#### Request Body
- **name** (string) - Optional - The name of the rule if not using ID.

### Response
#### Success Response (200)
- **status** (string) - Status of the operation.
- **message** (string) - Description of the result.
```

--------------------------------

### GET https://proxycheck.io/dashboard/export/usage/

Source: https://proxycheck.io/api

Retrieves current account usage statistics including query limits and plan information.

```APIDOC
## GET https://proxycheck.io/dashboard/export/usage/

### Description
Displays account usage for the current day, including query counts, total allowance, and plan tier.

### Method
GET

### Endpoint
https://proxycheck.io/dashboard/export/usage/

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.

### Response
#### Success Response (200)
- **Queries Today** (string) - Number of queries made today.
- **Daily Limit** (string) - Daily query allowance.
- **Plan Tier** (string) - Current subscription plan.

#### Response Example
{
    "Burst Tokens Available": 1,
    "Burst Token Allowance": 1,
    "Queries Today": "255",
    "Daily Limit": "1000",
    "Queries Total": "98523",
    "Plan Tier": "Free"
}
```

--------------------------------

### Custom Rule API Response

Source: https://proxycheck.io/api

Example JSON response returned after performing an action on a custom rule.

```json
{
    "status": "ok",
    "message": "Rule enabled."
}
```

--------------------------------

### API Request with Query Flags

Source: https://proxycheck.io/api

A GET request including additional flags to retrieve risk scores and VPN status.

```http
http://proxycheck.io/v2/37.60.48.2?key=111111-222222-333333-444444&risk=1&vpn=1
```

--------------------------------

### GET https://proxycheck.io/dashboard/export/queries/

Source: https://proxycheck.io/api

Retrieves historical query volume statistics for the past 30 days.

```APIDOC
## GET https://proxycheck.io/dashboard/export/queries/

### Description
Provides a breakdown of query volume over the past 30 days, categorized by detection types.

### Method
GET

### Endpoint
https://proxycheck.io/dashboard/export/queries/

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **json** (integer) - Required - Set to 1 to return JSON format.

### Response
#### Success Response (200)
- **date** (object) - Daily breakdown of query statistics.

#### Response Example
{
    "2025-09-07": {
        "total_queries": 55115,
        "positive_queries": 7535,
        "negative_queries": 47547,
        "proxy": 99,
        "vpn": 7490
    }
}
```

--------------------------------

### Basic API Request Structure

Source: https://proxycheck.io/api

A standard GET request to check a single IP address using an API key.

```http
http://proxycheck.io/v2/37.60.48.2?key=111111-222222-333333-444444
```

--------------------------------

### Positive Detection JSON Response Structure

Source: https://proxycheck.io/api

Example of the JSON object returned for a single detection entry in the export log.

```json
"1": {
    "time formatted": "23rd of November 2017 at 7:01 am",
    "time raw": "1511420515",
    "address": "177.154.145.103",
    "detection type": "vpn",
    "answering node": "ATLAS",
    "tag": "Login Attempt"
}
```

--------------------------------

### GET /dashboard/lists/[list_name]

Source: https://proxycheck.io/api

View or perform actions on custom lists. If no list name is provided, it returns a list of all available lists.

```APIDOC
## GET /dashboard/lists/[list_name]

### Description
Perform actions on a specific custom list or list all available lists.

### Method
GET (or POST for data modifications)

### Endpoint
https://proxycheck.io/dashboard/lists/[list_name]

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **type** (string) - Optional - The type of list (whitelist, blacklist, or none).

#### Request Body
- **data** (string) - Required for add, remove, or set actions - The data to be added, removed, or set in the list.

### Response
#### Success Response (200)
- **status** (string) - Status of the operation.
- **message** (string) - Description of the result.
```

--------------------------------

### Query Flags

Source: https://proxycheck.io/api

A collection of optional GET parameters that can be appended to API requests to control data retrieval and response structure.

```APIDOC
## Query Flags

### Description
Optional flags that can be appended to API requests to modify the data returned or the processing logic applied to the IP address.

### Method
GET

### Query Parameters
- **tag** (string) - Optional - A custom message to save with the query. If set to 0, disables tagging and saving to the positive detection log.
- **vpn** (integer) - Optional - Controls VPN check behavior (0: disabled, 1: proxy + VPN, 2: VPN only, 3: proxy + VPN with separate results).
- **asn** (integer) - Optional - Enables ASN data retrieval (0: disabled, 1: enabled).
- **cur** (integer) - Optional - Controls currency display (0: disabled, 1: enabled, requires asn=1).
- **node** (integer) - Optional - Displays the cluster node that answered the call (0: disabled, 1: enabled).
- **time** (integer) - Optional - Displays query execution time (0: disabled, 1: enabled).
- **risk** (integer) - Optional - Controls risk scoring (0: disabled, 1: score 0-100, 2: score + attack counts).
- **port** (integer) - Optional - Displays the proxy port number (0: disabled, 1: enabled).
- **seen** (integer) - Optional - Displays the most recent time the IP was seen as a proxy (0: disabled, 1: enabled).
- **short** (integer) - Optional - Compresses the result format (0: disabled, 1: enabled).
- **p** (integer) - Optional - Controls pretty formatting (0: single line, 1: human-readable).
- **days** (integer) - Optional - Restricts proxy results to a specific number of days (default: 7).
```

--------------------------------

### GET https://proxycheck.io/dashboard/export/tags/

Source: https://proxycheck.io/api

Retrieves tag data logged during IP checks, allowing for analysis of attack patterns and traffic sources.

```APIDOC
## GET https://proxycheck.io/dashboard/export/tags/

### Description
Retrieves tag data logged during IP checks. This endpoint helps identify where attacks are occurring by providing details on tags, associated IP addresses, and detection types.

### Method
GET

### Endpoint
https://proxycheck.io/dashboard/export/tags/

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.
- **limit** (integer) - Optional - Number of entries to return (default 100, max 1000).
- **offset** (integer) - Optional - Offset for pagination.
- **addresses** (integer) - Optional - Set to 1 to include associated IP addresses.
- **days** (integer) - Optional - Number of days in the past to view data.
- **start** (integer) - Optional - Start time as a unix timestamp.
- **end** (integer) - Optional - End time as a unix timestamp.

### Response
#### Success Response (200)
- **tag_name** (object) - Data object containing types and addresses associated with the tag.

#### Response Example
{
    "www.example.com/wp-comments-post.php": {
        "types": {
            "total": 11,
            "proxy": 4,
            "vpn": 4,
            "rule": 3
        },
        "addresses": {
            "149.28.76.201": 4,
            "87.107.18.84": 4,
            "62.210.83.206": 3
        }
    }
}
```

--------------------------------

### Email Address Check via URL

Source: https://proxycheck.io/api

Checking an email address using the GET method. Note that certain characters in email addresses may cause this method to fail.

```http
http://proxycheck.io/v2/john.smith@example.com?key=111111-222222-333333-444444
```

--------------------------------

### Bulk Check via POST Method

Source: https://proxycheck.io/api

Recommended method for checking multiple IP or email addresses to avoid URL character issues.

```http
http://proxycheck.io/v2/?key=111111-222222-333333-444444  
POST DATA: ips=8.8.8.8,1.1.1.1,37.60.48.2,john.smith@example.com
```

--------------------------------

### Print Specific Custom List

Source: https://proxycheck.io/api

Retrieves the contents of a specific list by name.

```text
https://proxycheck.io/dashboard/lists/print/whitelist?key=111111-222222-333333-444444&type=whitelist
```

--------------------------------

### View Custom Rules

Source: https://proxycheck.io/api

Retrieves a list of all available custom rules.

```text
https://proxycheck.io/dashboard/rules/print/?key=111111-222222-333333-444444
```

--------------------------------

### View Custom Lists

Source: https://proxycheck.io/api

Retrieves a list of all available custom lists.

```text
https://proxycheck.io/dashboard/lists/print/?key=111111-222222-333333-444444
```

--------------------------------

### Configure Node Flag

Source: https://proxycheck.io/api

Enable or disable the display of the specific server node that processed the query for diagnostic purposes.

```text
& node=1
```

```text
& node=0
```

--------------------------------

### POST /v2/{address}

Source: https://proxycheck.io/api

Perform a lookup using the POST method, allowing for the inclusion of a tag message.

```APIDOC
## POST /v2/{address}

### Description
Perform a lookup using the POST method, allowing for the inclusion of a tag message to identify your query.

### Method
POST

### Endpoint
/v2/{address}

### Parameters
#### Path Parameters
- **address** (string) - Required - The IP address or email address to check.

#### Request Body
- **tag** (string) - Optional - A message to tag your query with.
```

--------------------------------

### POST /v2/

Source: https://proxycheck.io/api

Check multiple IP addresses or email addresses in a single request using the POST method.

```APIDOC
## POST /v2/

### Description
Check multiple IP addresses or email addresses by providing them in the POST body. This is recommended for email addresses to avoid URL character issues.

### Method
POST

### Endpoint
http://proxycheck.io/v2/

### Parameters
#### Query Parameters
- **key** (string) - Optional - Your API key.

#### Request Body
- **ips** (string) - Required - A comma-separated list of IP addresses or email addresses to check.
```

--------------------------------

### Check multiple addresses via POST

Source: https://proxycheck.io/api

Perform a bulk check of IP and email addresses by sending them in the POST body as 'ips'.

```text
http://proxycheck.io/v3/?key=111111-222222-333333-444444  
POST DATA: ips=8.8.8.8,1.1.1.1,37.60.48.2,john.smith@example.com
```

--------------------------------

### POST /v3/

Source: https://proxycheck.io/api

Perform a check on one or multiple IP or email addresses using a POST request.

```APIDOC
## POST /v3/

### Description
Check multiple IP or email addresses in a single query. This method is recommended for email addresses to avoid issues with special characters.

### Method
POST

### Endpoint
http://proxycheck.io/v3/

### Parameters
#### Query Parameters
- **key** (string) - Optional - Your API key.

#### Request Body
- **ips** (string) - Required - A comma-separated list of IP or email addresses to check.

### Request Example
POST DATA: ips=8.8.8.8,1.1.1.1,37.60.48.2,john.smith@example.com
```

--------------------------------

### Query Flags Reference

Source: https://proxycheck.io/api

Overview of available query flags for customizing API requests.

```APIDOC
## Query Flags

### Description
Query flags allow you to modify the behavior of your API requests, such as tagging detections, formatting output, or restricting result timeframes.

### Parameters
#### Query Parameters
- **tag** (string) - Optional - A descriptive term stored with positive detections. Use &tag=0 to disable logging.
- **node** (integer) - Optional - Set to 1 to display the cluster node that answered the call.
- **short** (integer) - Optional - Set to 1 to compress the result structure.
- **p** (integer) - Optional - Set to 1 for pretty formatting, 0 for single-line output.
- **days** (integer) - Optional - Restrict positive detection results to the specified number of days.
- **ver** (string) - Optional - Override the API version using a date format (e.g., 24-June-2026).

### Request Example
GET http://proxycheck.io/v3/37.60.48.2?tag=Account%20Signup%20Page&p=1
```

--------------------------------

### Detect Proxies and VPNs with JavaScript

Source: https://proxycheck.io/api

Uses jQuery to query the ProxyCheck.io API and redirect users if an anonymous connection is detected. Requires jQuery to be loaded on the page.

```html
<!-- JQuery is required, you can use Google's CDN for it or self-host it. -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>

<script>
$.getJSON("//proxycheck.io/v3/?key=public-######-######-######", function( json ) {
if ((json.status == "warning" || json.status == "ok") && json[json.ip].detections.anonymous == true ) {
  window.location.href = "https://www.example.com";
}
});
</script>
```

--------------------------------

### Apply query flags to a request

Source: https://proxycheck.io/api

Use query flags like 'days' and 'tag' to modify the API response.

```text
http://proxycheck.io/v3/37.60.48.2?key=111111-222222-333333-444444&days=7&tag=msg
```

--------------------------------

### Configure ASN Flag

Source: https://proxycheck.io/api

Enable or disable ASN, location, and provider information in the API response.

```text
& asn=1
```

```text
& asn=0
```

--------------------------------

### Retrieve Country List

Source: https://proxycheck.io/api

JSON array containing a comprehensive list of global countries and territories.

```json
["Andorra","United Arab Emirates","Afghanistan","Antigua and Barbuda","Anguilla","Albania","Armenia","Angola","Antarctica","Argentina","American Samoa","Austria","Australia","Aruba","Aland Islands","Azerbaijan","Bosnia and Herzegovina","Barbados","Bangladesh","Belgium","Burkina Faso","Bulgaria","Bahrain","Burundi","Benin","Saint Barthelemy","Bermuda","Brunei","Bolivia","Bonaire, Saint Eustatius and Saba ","Brazil","Bahamas","Bhutan","Bouvet Island","Botswana","Belarus","Belize","Canada","Cocos Islands","Democratic Republic of the Congo","Central African Republic","Republic of the Congo","Switzerland","Ivory Coast","Cook Islands","Chile","Cameroon","China","Colombia","Costa Rica","Cuba","Cabo Verde","Curacao","Christmas Island","Cyprus","Czechia","Germany","Djibouti","Denmark","Dominica","Dominican Republic","Algeria","Ecuador","Estonia","Egypt","Western Sahara","Eritrea","Spain","Ethiopia","Finland","Fiji","Falkland Islands","Micronesia","Faroe Islands","France","Gabon","United Kingdom","Grenada","Georgia","French Guiana","Guernsey","Ghana","Gibraltar","Greenland","Gambia","Guinea","Guadeloupe","Equatorial Guinea","Greece","South Georgia and the South Sandwich Islands","Guatemala","Guam","Guinea-Bissau","Guyana","Hong Kong","Heard Island and McDonald Islands","Honduras","Croatia","Haiti","Hungary","Indonesia","Ireland","Israel","Isle of Man","India","British Indian Ocean Territory","Iraq","Iran","Iceland","Italy","Jersey","Jamaica","Jordan","Japan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Comoros","Saint Kitts and Nevis","North Korea","South Korea","Kosovo","Kuwait","Cayman Islands","Kazakhstan","Laos","Lebanon","Saint Lucia","Liechtenstein","Sri Lanka","Liberia","Lesotho","Lithuania","Luxembourg","Latvia","Libya","Morocco","Monaco","Moldova","Montenegro","Saint Martin","Madagascar","Marshall Islands","North Macedonia","Mali","Myanmar","Mongolia","Macao","Northern Mariana Islands","Martinique","Mauritania","Montserrat","Malta","Mauritius","Maldives","Malawi","Mexico","Malaysia","Mozambique","Namibia","New Caledonia","Niger","Norfolk Island","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","Niue","New Zealand","Oman","Panama","Peru","French Polynesia","Papua New Guinea","Philippines","Pakistan","Poland","Saint Pierre and Miquelon","Pitcairn","Puerto Rico","Palestinian Territory","Portugal","Palau","Paraguay","Qatar","Reunion","Romania","Serbia","Russia","Rwanda","Saudi Arabia","Solomon Islands","Seychelles","Sudan","South Sudan","Sweden","Singapore","Saint Helena","Slovenia","Svalbard and Jan Mayen","Slovakia","Sierra Leone","San Marino","Senegal","Somalia","Suriname","Sao Tome and Principe","El Salvador","Sint Maarten","Syria","Eswatini","Turks and Caicos Islands","Chad","French Southern Territories","Togo","Thailand","Tajikistan","Tokelau","Timor Leste","Turkmenistan","Tunisia","Tonga","Turkey","Trinidad and Tobago","Tuvalu","Taiwan","Tanzania","Ukraine","Uganda","United States Minor Outlying Islands","United States","Uruguay","Uzbekistan","Vatican","Saint Vincent and the Grenadines","Venezuela","British Virgin Islands","U.S. Virgin Islands","Vietnam","Vanuatu","Wallis and Futuna","Samoa","Yemen","Mayotte","South Africa","Zambia","Zimbabwe","Serbia and Montenegro","Netherlands Antilles"]
```

--------------------------------

### Configure Day Restrictor Flag

Source: https://proxycheck.io/api

Limit the search window for proxy detections to a specific number of days.

```text
& days=0.01
```

```text
& days=1
```

```text
& days=7
```

--------------------------------

### Configure Tag Flag

Source: https://proxycheck.io/api

Specify a descriptive term to store with positive detections for tracking purposes.

```text
GET Example: http://proxycheck.io/v2/37.60.48.2?tag=Account%20Signup%20Page
```

```text
POST Example: tag=Account Signup Page
```

--------------------------------

### Configure Last Seen Flag

Source: https://proxycheck.io/api

Enable or disable the display of the most recent timestamp when the IP was observed as a proxy server.

```text
& seen=1
```

```text
& seen=0
```

--------------------------------

### Configure Port Number Flag

Source: https://proxycheck.io/api

Enable or disable the display of detected proxy server port numbers.

```text
& port=1
```

```text
& port=0
```

--------------------------------

### Export Account Usage

Source: https://proxycheck.io/api

Retrieve current account usage statistics including query limits and plan tier.

```text
https://proxycheck.io/dashboard/export/usage/?key=111111-222222-333333-444444
```

--------------------------------

### Enable Custom Rule by ID

Source: https://proxycheck.io/api

Enables a specific custom rule using its unique ID.

```text
https://proxycheck.io/dashboard/rules/enable/4o4h6107e089?key=111111-222222-333333-444444
```

--------------------------------

### POST https://proxycheck.io/dashboard/cors/[action]/?key=[key]

Source: https://proxycheck.io/api

Perform actions on your CORS origin list including listing, adding, removing, setting, or clearing origins.

```APIDOC
## POST https://proxycheck.io/dashboard/cors/[action]/?key=[key]

### Description
Perform an action on your CORS origin list. Actions include listing current origins, adding new ones, removing existing ones, setting the list, or clearing all origins.

### Method
POST

### Endpoint
https://proxycheck.io/dashboard/cors/[action]/?key=[key]

### Parameters
#### Path Parameters
- **action** (string) - Required - The action to perform: list, add, remove, set, or clear.

#### Query Parameters
- **key** (string) - Required - Your API key.

#### Request Body
- **data** (string) - Optional - The origin(s) to process. Required for add, remove, and set actions. Supports newline-separated values for multiple origins.

### Response
#### Success Response (200)
- **success** (string) - Confirmation message.
- **origin_count** (integer) - The total number of origins after the operation.

### Response Example
{
  "success": "Your origins have been updated.",
  "origin_count": 5
}
```

--------------------------------

### Export Positive Detections API Request

Source: https://proxycheck.io/api

The endpoint URL for exporting recent positive detections. Requires an API key and supports limit, offset, and filter parameters.

```text
https://proxycheck.io/dashboard/export/detections/?json=1&key=111111-222222-333333-444444&limit=100&offset=0&filter=word
```

--------------------------------

### Client-Side Proxy Detection with jQuery

Source: https://proxycheck.io/api

Uses jQuery to perform a cross-origin request to the ProxyCheck.io API and redirects users if a proxy or VPN is detected. Requires jQuery to be loaded on the page.

```html
<!-- JQuery is required, you can use Google's CDN for it or self-host it. -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>

<!-- You can modify the URL used below to include our different query flags like how we included &vpn=1. -->
<script>
  $.getJSON("//proxycheck.io/v2/?key=public-######-######-######&vpn=1", function( json ) {
    if ((json.status == "warning" || json.status == "ok") && json[json.ip].proxy == "yes" ) {
      window.location.href = "https://www.example.com";
    }
 });
</script>
```

--------------------------------

### Export Tag Data via API

Source: https://proxycheck.io/api

Retrieve tag data using a limit, offset, and day-based filtering.

```text
https://proxycheck.io/dashboard/export/tags/?key=111111-222222-333333-444444&limit=100&offset=0&addresses=1&days=1
```

```text
https://proxycheck.io/dashboard/export/tags/?key=111111-222222-333333-444444&limit=100&offset=0&addresses=1&start=1566648271&end=1566345271
```

--------------------------------

### Network Section with Null Value

Source: https://proxycheck.io/api

Demonstrates how missing data is represented using the null literal instead of an empty string.

```json
"network": {
    "asn": "AS16509",
    "range": "98.75.0.0/16",
    "hostname": null,
    "provider": "Amazon.com, Inc.",
    "organisation": "Amazon.com, Inc.",
    "type": "Hosting"
}
```

--------------------------------

### Query Flags

Source: https://proxycheck.io/api

Optional parameters that can be appended to API requests to retrieve additional data or filter results.

```APIDOC
## Query Flags

### Parameters
#### Query Parameters
- **asn** (integer) - Optional - Set to 1 to view ASN, Location, and Provider information. Default is 0.
- **node** (integer) - Optional - Set to 1 to view the server node that processed the query. Default is 0.
- **risk** (integer) - Optional - Set to 1 to receive a risk score (0-100). Set to 2 to receive a risk score and attack history. Default is 0.
- **port** (integer) - Optional - Set to 1 to display port numbers for detected proxy servers. Default is 0.
- **seen** (integer) - Optional - Set to 1 to display the last time the IP was seen as a proxy. Default is 0.
- **days** (float) - Optional - Restrict proxy search to a specific time range in days (0.01 to 60). Default is 7.
- **tag** (string) - Optional - A descriptive term stored with positive detections for dashboard tracking.
```

--------------------------------

### Disabling Positive Detection Logging

Source: https://proxycheck.io/api

Use the tag flag with a value of 0 to prevent the query from being saved to the positive detection log.

```http
& tag=0
```

--------------------------------

### Retrieve Continent List

Source: https://proxycheck.io/api

JSON array containing a list of global continents.

```json
["Africa","Asia","Europe","North America","Oceania","South America","Antarctica"]
```

--------------------------------

### Retrieve CORS Origin Domains

Source: https://proxycheck.io/api

API endpoint URL for listing current origin domains associated with an account.

```text
https://proxycheck.io/dashboard/cors/list/?key=111111-222222-333333-444444
```

--------------------------------

### Export Query Volume

Source: https://proxycheck.io/api

Retrieve historical query volume for the past 30 days.

```text
https://proxycheck.io/dashboard/export/queries/?json=1&key=111111-222222-333333-444444
```

--------------------------------

### API Response Format

Source: https://proxycheck.io/api

JSON structure returned by the API indicating the status and disposable email check result.

```json
{
"status": "ok",
"john.smith@gmail.com": {
    "disposable": "no"
}
}
```

--------------------------------

### Configure Risk Assessment Score Flag

Source: https://proxycheck.io/api

Control the level of risk assessment data returned, including optional attack history based on the days flag.

```text
& risk=1
```

```text
& risk=2
```

```text
& risk=0
```
Tokens:
Raw