IP Security API
Overview
The IP Security API returns detailed threat flags for any IPv4 or IPv6 address. It detects whether an IP is associated with a VPN, a proxy, a residential proxy, a Tor exit node, a relay, bot activity, spam activity, or known attacker behavior. For VPN and proxy signals, it also returns confidence scores, provider names, and last seen timestamps when available. This helps you reliably identify anonymous and masked traffic before it reaches your systems.
The API also checks whether the IP is linked to a cloud provider and, when available, returns the cloud provider name.
IP Security API Lookup Endpoints
The IP Security API offers two endpoints for IP risk assessment: single lookup and bulk lookup. Below you’ll find details and examples for both endpoints, along with the full list of optional query parameters and how to use them with each endpoint.
Please note the following:
- After adding your website as a Request Origin in the Billing Dashboard, you can call the endpoints below directly from the client-side without including the
apiKeyquery parameter to help prevent unauthorized use of your API key. - Base URL (v3):
https://api.ipgeolocation.io/v3/security - Responses are returned in
JSONby default. To receive XML, addoutput=xml. You can also explicitly request JSON withoutput=json.
X-Credits-Charged response header shows the total credits charged for the request. For details, please refer to our Credits Usage Guide.Single IP Lookup Endpoint
1.Lookup the caller IP (no ip parameter)
If you don’t pass the ip parameter, the API automatically detects the public IP address of the requesting client and returns its threat score and security signals (for example, VPN/proxy/Tor/bot/spam/hosting indicators and the provider names when available). Use this option when you want to assess the IP risk of the requesting client without specifying an IP address.
curl -X GET 'https://api.ipgeolocation.io/v3/security?apiKey=API_KEY'1{
2 "ip": "5.187.10.7",
3 "security": {
4 "threat_score": 75,
5 "is_tor": false,
6 "is_proxy": true,
7 "proxy_provider_names": [
8 "Evomi Proxy",
9 "IPRoyal",
10 "922 Proxy"
11 ],
12 "proxy_confidence_score": 99,
13 "proxy_last_seen": "2026-01-28",
14 "is_residential_proxy": true,
15 "is_vpn": false,
16 "vpn_provider_names": [],
17 "vpn_confidence_score": 0,
18 "vpn_last_seen": "",
19 "is_relay": false,
20 "relay_provider_name": "",
21 "is_anonymous": true,
22 "is_known_attacker": true,
23 "is_bot": false,
24 "is_spam": false,
25 "is_cloud_provider": false,
26 "cloud_provider_name": ""
27 }
28}2.Lookup a specific IP address
Pass the ip parameter to check a specific IPv4 or IPv6 address. The API returns the threat score and security signals (such as VPN, proxy, residential proxy, Tor, bot, spam, relay, and hosting flags), along with provider names, confidence scores, and last seen dates when available.
curl -X GET 'https://api.ipgeolocation.io/v3/security?apiKey=API_KEY&ip=2.56.188.34'1{
2 "ip": "2.56.188.34",
3 "security": {
4 "threat_score": 80,
5 "is_tor": false,
6 "is_proxy": true,
7 "proxy_provider_names": [
8 "Zyte Proxy"
9 ],
10 "proxy_confidence_score": 90,
11 "proxy_last_seen": "2025-12-12",
12 "is_residential_proxy": true,
13 "is_vpn": true,
14 "vpn_provider_names": [
15 "Nord VPN"
16 ],
17 "vpn_confidence_score": 99,
18 "vpn_last_seen": "2026-01-19",
19 "is_relay": false,
20 "relay_provider_name": "",
21 "is_anonymous": true,
22 "is_known_attacker": true,
23 "is_bot": false,
24 "is_spam": false,
25 "is_cloud_provider": true,
26 "cloud_provider_name": "Packethub S.A."
27 }
28}Additional Query Parameters
Use these query parameters to exclude fields, or return only the fields you need.
1.Exclude Fields ( excludes )
Use excludes to remove fields you don’t need from the response. Pass a comma-separated list of field paths.
How to write field paths: Use dot notation for nested fields: object.field . For example:
- Exclude specific flags:
security.is_tor,security.is_cloud_provider
-
ipis always included and cannot be excluded.
An example request and response are shown below.
curl -X GET 'https://api.ipgeolocation.io/v3/security?apiKey=API_KEY&ip=2.56.188.34&excludes=security.is_tor,security.is_cloud_provider'1{
2 "ip": "2.56.188.34",
3 "security": {
4 "threat_score": 80,
5 "is_proxy": true,
6 "proxy_provider_names": [
7 "Zyte Proxy"
8 ],
9 "proxy_confidence_score": 90,
10 "proxy_last_seen": "2025-12-12",
11 "is_residential_proxy": true,
12 "is_vpn": true,
13 "vpn_provider_names": [
14 "Nord VPN"
15 ],
16 "vpn_confidence_score": 99,
17 "vpn_last_seen": "2026-01-19",
18 "is_relay": false,
19 "relay_provider_name": "",
20 "is_anonymous": true,
21 "is_known_attacker": true,
22 "is_bot": false,
23 "is_spam": false,
24 "cloud_provider_name": "Packethub S.A."
25 }
26}In this example, the response does not contain is_tor and is_cloud_provider in the security object.
2.Return Specific Fields ( fields )
Use fields to return only the response fields you need. This helps reduce response size and keeps the payload focused.
How to specify fields: Provide a comma-separated list using dot notation: object.field . For example:
- Security score:
security.threat_score
An example request and response are shown below.
curl -X GET 'https://api.ipgeolocation.io/v3/security?apiKey=API_KEY&ip=2.56.188.34&fields=security.threat_score'1{
2 "ip": "2.56.188.34",
3 "security": {
4 "threat_score": 80
5 }
6}Bulk IP Security Lookup Endpoint
Use this endpoint to assess IP risk for large lists of IP addresses in a single request (up to 50,000 IPs per request).
The bulk lookup supports the same query parameters as the single lookup, so you can use excludes and fields to control the response.
In the response, each IP is returned with its own security result. This makes it easy to process results in batches for signups, log analysis, fraud checks, and monitoring workflows.
An example request and response are shown below.
curl -X POST 'https://api.ipgeolocation.io/v3/security-bulk?apiKey=API_KEY' \
-H 'Content-Type: application/json' \
-d '{"ips":["2.56.188.34","2.56.188.35"]}'1[
2 {
3 "ip": "2.56.188.34",
4 "security": {
5 "threat_score": 80,
6 "is_tor": false,
7 "is_proxy": true,
8 "proxy_provider_names": [
9 "Zyte Proxy"
10 ],
11 "proxy_confidence_score": 90,
12 "proxy_last_seen": "2025-12-12",
13 "is_residential_proxy": true,
14 "is_vpn": true,
15 "vpn_provider_names": [
16 "Nord VPN"
17 ],
18 "vpn_confidence_score": 99,
19 "vpn_last_seen": "2026-01-19",
20 "is_relay": false,
21 "relay_provider_name": "",
22 "is_anonymous": true,
23 "is_known_attacker": true,
24 "is_bot": false,
25 "is_spam": false,
26 "is_cloud_provider": true,
27 "cloud_provider_name": "Packethub S.A."
28 }
29 },
30 {
31 "ip": "2.56.188.35",
32 "security": {
33 "threat_score": 80,
34 "is_tor": false,
35 "is_proxy": true,
36 "proxy_provider_names": [
37 "Zyte Proxy"
38 ],
39 "proxy_confidence_score": 90,
40 "proxy_last_seen": "2025-11-07",
41 "is_residential_proxy": true,
42 "is_vpn": false,
43 "vpn_provider_names": [],
44 "vpn_confidence_score": 0,
45 "vpn_last_seen": "",
46 "is_relay": false,
47 "relay_provider_name": "",
48 "is_anonymous": true,
49 "is_known_attacker": true,
50 "is_bot": false,
51 "is_spam": false,
52 "is_cloud_provider": true,
53 "cloud_provider_name": "Packethub S.A."
54 }
55 }
56]Reference to IP Security API Response
Below, we provide separate tables for each JSON object in the response, listing all possible fields available across the security endpoint.
1.Standalone fields reference
| Field | Type | Description | Can be empty? |
|---|---|---|---|
| ip | string | IP address that is used to lookup security information. | No |
2. security json object reference
| Field | Type | Description | Can be empty? |
|---|---|---|---|
| threat_score | number | Overall threat score for the IP address. Ranges from 0 to 100. 100 indicates the highest risk. | No |
| is_tor | boolean | Indicates whether the IP is a Tor exit node. | No |
| is_proxy | boolean | Indicates whether the IP is associated with a proxy network. | No |
| proxy_provider_names | array[string] | List of detected proxy provider names, when available. | Yes |
| proxy_confidence_score | number | Confidence score (0–100) for proxy detection, when flag is true. Defaults to 0. | No |
| proxy_last_seen | string | Last seen date (YYYY-MM-DD) for proxy activity, when available. | Yes |
| is_residential_proxy | boolean | Indicates whether the IP is associated with a residential proxy network. | No |
| is_vpn | boolean | Indicates whether the IP is associated with a VPN network. | No |
| vpn_provider_names | array[string] | List of detected VPN provider names, when available. | Yes |
| vpn_confidence_score | number | Confidence score (0–100) for VPN detection, when flag is true. Defaults to 0. | No |
| vpn_last_seen | string | Last seen date (YYYY-MM-DD) for VPN activity, when available. | Yes |
| is_relay | boolean | Indicates whether the IP is associated with a relay network. | No |
| relay_provider_name | string | Relay provider name, when available. | Yes |
| is_anonymous | boolean | Indicates whether the IP is anonymous. True if VPN, proxy, Tor, or relay is detected. | No |
| is_known_attacker | boolean | Indicates whether the IP is flagged for known attacker behavior. | No |
| is_bot | boolean | Indicates whether the IP is associated with bot activity. | No |
| is_spam | boolean | Indicates whether the IP is associated with spam activity. | No |
| is_cloud_provider | boolean | Indicates whether the IP belongs to a cloud provider. | No |
| cloud_provider_name | string | Name of the Cloud Provider, if the IP address belongs to a cloud provider. | Yes |
Error Codes
IP Security API returns HTTP status code 200 for a successful API request along with the response.
While, in case of a bad or invalid request, IP Security API returns 4xx HTTP status code along with a descriptive message explaining the reason for the error.
Below is a detailed explanation of the specific HTTP status codes and their corresponding error conditions:
| HTTP Status | Description |
|---|---|
| 400 Bad Request | It is returned for one of the following reasons:
|
| 401 Unauthorized | It is returned for one of the following reasons:
|
| 404 Not Found | It is returned for one of the following reasons:
|
| 405 Method Not Allowed |
|
| 413 Content Too Large |
|
| 415 Unsupported Media Type |
|
| 423 Locked |
|
| 429 Too Many Requests | It is returned for one of the following reasons:
|
| 499 Client Closed Request |
|
| 5XX Server Side Error |
|
API SDKs
To facilitate the developers, we have added some SDKs for various programming languages. The detailed documentation on how to use these SDKs is available in the respective SDK's documentation page linked below.
Our SDKs are also available on Github. Feel free to help us improve them. Following are the available SDKs:
Frequently Asked Questions
Each Security lookup costs 2 credits per valid IP. The X-Credits-Charged response header shows the total credits charged for the request. For details, please refer to our Credits Usage Guide.
In bulk lookup, 2 credits are charged for each valid IP in the payload. Bogon, private, or malformed IPs are not counted. The X-Credits-Charged response header shows the total credits charged for the request. For details, please refer to our Credits Usage Guide.
- Proxy: Forwards traffic through another server and mainly masks the IP.
- VPN: Routes traffic through a remote server and encrypts and tunnels the connection.
- Tor: Routes traffic through multiple nodes to provide stronger anonymity.
Yes. A free trial is available so you can test accuracy and integration. Please contact us via customer support or use the live chat on our website to request access.
Yes. You can download sample VPN and proxy data that includes the same risk flags returned by this API, so you can review the structure and quality. Please see Security Databases for examples and formats, or contact support if you want help choosing the right dataset or if you want data for your own IP ranges.