IPLocate.io Developer Documentation

https://www.iplocate.io/docs
Admin
IPLocate.io provides an API for retrieving detailed geolocation and ASN data for IPv4 and IPv6...
Tokens:27,286
Snippets:239
Trust Score:9.3
Update:2 days ago
Show doc for...
Tokens:
Raw
### Install Go client library with go get

Source: https://www.iplocate.io/docs/integrations/client-libraries

Install the go-iplocate package using go get.

```bash
go get github.com/iplocate/go-iplocate
```

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

### Install PHP client library with Composer

Source: https://www.iplocate.io/docs/integrations/client-libraries

Install the iplocate/php-iplocate package using Composer.

```bash
composer require iplocate/php-iplocate
```

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

### Install Ruby client library with gem

Source: https://www.iplocate.io/docs/integrations/client-libraries

Install the iplocate gem.

```bash
gem install iplocate
```

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

### Get full details example

Source: https://www.iplocate.io/docs/integrations/mcp-server

Example tool invocation to retrieve full IP record including geolocation, ASN, privacy, company, and abuse data.

```json
{
  "tool": "lookup_ip_address_details",
  "params": {"ip": "1.1.1.1"}
}
```

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

### Install is-in-subnet package

Source: https://www.iplocate.io/docs/guides/bogons

Install the `is-in-subnet` npm package, which is required for the bogon pre-check example.

```bash
npm install is-in-subnet
```

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

### Install Node.js client library with npm, yarn, or pnpm

Source: https://www.iplocate.io/docs/integrations/client-libraries

Install the node-iplocate package using npm, yarn, or pnpm.

```bash
npm install node-iplocate
# or
yarn add node-iplocate
# or
pnpm add node-iplocate
```

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

### Install Python client library with pip

Source: https://www.iplocate.io/docs/integrations/client-libraries

Install the python-iplocate package using pip.

```bash
pip install python-iplocate
```

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

### Look up an IP address using the MMDB database with Node.js

Source: https://www.iplocate.io/docs/data-feeds/free-ip-to-country-database

Use the mmdb-lib library to read the MMDB database file and perform local IP lookups. The example shows both reader.get() and reader.getWithPrefixLength() methods, with sample output for the IP 8.8.8.8. Requires npm install mmdb-lib and the database file at /path/to/ip-to-country.mmdb.

```javascript
import fs from 'fs';
import * as mmdb from 'mmdb-lib'; // npm install mmdb-lib

const db = fs.readFileSync('/path/to/ip-to-country.mmdb');

const reader = new mmdb.Reader(db);
console.log(reader.get('8.8.8.8'));
// {
//   continent_code: 'NA',
//   country_code: 'US',
//   country_name: 'United States',
//   network: '8.8.0.0/17'
// }

console.log(reader.getWithPrefixLength('8.8.8.8'));
// [
//   {
//     continent_code: 'NA',
//     country_code: 'US',
//     country_name: 'United States',
//     network: '8.8.0.0/17'
//   },
//   17
// ]
```

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

### Check IP security posture example

Source: https://www.iplocate.io/docs/integrations/mcp-server

Example tool invocation to check privacy signals (VPN, proxy, Tor, hosting) for a given IP address.

```json
{
  "tool": "lookup_ip_address_privacy",
  "params": {"ip": "8.8.8.8"}
}
```

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

### Node.js example: isFromHosting function

Source: https://www.iplocate.io/docs/guides/detect-hosting-traffic

Uses the node-iplocate client to look up an IP and return whether it is from a hosting provider along with the provider name. The example calls isFromHosting() and shows how to conditionally handle the result.

```javascript
import IPLocate from 'node-iplocate';

const client = new IPLocate('YOUR_API_KEY');

export async function isFromHosting(ip = '') {
  const data = await client.lookup(ip);
  return {
    hosting: data.privacy?.is_hosting === true,
    provider: data.hosting?.provider,
  };
}

// Example
const result = await isFromHosting();
if (result.hosting) {
  // Block, log, throttle, or route differently
}
```

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

### Example lookup using the EU API endpoint

Source: https://www.iplocate.io/docs/reference/eu-api-endpoint

Example curl command to perform an IP lookup using the EU API endpoint. Replace YOUR_API_KEY with your actual API key.

```bash
curl "https://eu-api.iplocate.io/api/lookup/8.8.8.8?apikey=YOUR_API_KEY"
```

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

### Server-side redirect with Express and node-iplocate

Source: https://www.iplocate.io/docs/guides/country-based-redirects

Use this Express server example to perform country-based redirects on the server. It uses the node-iplocate package and requires the IPLOCATE_API_KEY environment variable. The server trusts the proxy to get the client IP and redirects to '/fr/' or '/de/' based on country_code, otherwise sends 'Home'.

```javascript
import express from 'express';
import IPLocate from 'node-iplocate';

const app = express();
app.set('trust proxy', true);

const client = new IPLocate(process.env.IPLOCATE_API_KEY);

app.get('/', async (req, res) => {
  const ip = req.ip;
  const data = await client.lookup(ip);

  if (data.country_code === 'FR') return res.redirect(302, '/fr/');
  if (data.country_code === 'DE') return res.redirect(302, '/de/');
  return res.send('Home');
});
```

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

### IPv4 lookup response example

Source: https://www.iplocate.io/docs/reference/ipv4-ipv6

Example JSON response for an IPv4 address lookup (8.8.8.8). Shows the returned fields: ip, country, country_code, and is_eu.

```json
{
  "ip": "8.8.8.8",
  "country": "United States",
  "country_code": "US",
  "is_eu": false
}
```

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

### IPv6 lookup response example

Source: https://www.iplocate.io/docs/reference/ipv4-ipv6

Example JSON response for an IPv6 address lookup (2001:4860:4860::8888). Shows the same response structure as IPv4.

```json
{
  "ip": "2001:4860:4860::8888",
  "country": "United States",
  "country_code": "US",
  "is_eu": false
}
```

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

### Example JSON response

Source: https://www.iplocate.io/docs/ip-intelligence-api

Example JSON response from the IP lookup endpoint showing comprehensive IP intelligence data including geolocation, ASN, privacy, hosting, company, and abuse information.

```json
{
  "ip": "8.8.8.8",
  "country": "United States",
  "country_code": "US",
  "is_eu": false,
  "city": "Mountain View",
  "continent": "North America",
  "latitude": 37.38605,
  "longitude": -122.08385,
  "time_zone": "America/Los_Angeles",
  "postal_code": "94035",
  "subdivision": "California",
  "currency_code": "USD",
  "calling_code": "1",
  "is_anycast": true,
  "is_satellite": false,
  "asn": {
    "asn": "AS15169",
    "route": "8.8.8.0/24",
    "netname": "GOOGLE",
    "name": "Google LLC",
    "country_code": "US",
    "domain": "google.com",
    "type": "hosting",
    "rir": "ARIN"
  },
  "privacy": {
    "is_abuser": false,
    "is_anonymous": true,
    "is_bogon": false,
    "is_hosting": true,
    "is_icloud_relay": false,
    "is_proxy": false,
    "is_tor": false,
    "is_vpn": true
  },
  "hosting": {
    "provider": "Google Cloud",
    "domain": "cloud.google.com",
    "network": "8.8.8.0/24"
  },
  "company": {
    "name": "Google LLC",
    "domain": "google.com",
    "country_code": "US",
    "type": "hosting"
  },
  "abuse": {
    "address": "1600 Amphitheatre Parkway, Mountain View, CA, 94043, US",
    "country_code": "US",
    "email": "network-abuse@google.com",
    "name": "Google LLC",
    "network": "8.8.8.0 - 8.8.8.255",
    "phone": "+1-650-253-0000"
  }
}
```

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

### Example geolocation response JSON

Source: https://www.iplocate.io/docs/ip-intelligence-api/data-types

Example JSON response from the IPLocate API showing the base geolocation fields. Fields not available are null, and top-level objects may be omitted if not relevant.

```json
{
  "ip": "8.8.8.8",
  "country": "United States",
  "country_code": "US",
  "is_eu": false,
  "city": "Mountain View",
  "continent": "North America",
  "latitude": 37.40599,
  "longitude": -122.078514,
  "time_zone": "America/Los_Angeles",
  "postal_code": "94043",
  "subdivision": "California",
  "currency_code": "USD",
  "calling_code": "1",
  "network": "8.8.8.0/24",
  "is_anycast": false,
  "is_satellite": false
}
```

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

### Authenticate with JavaScript client library

Source: https://www.iplocate.io/docs/getting-started/authentication

Use the 'node-iplocate' JavaScript library to authenticate by passing the API key to the constructor. The example imports IPLocate, creates a client with 'YOUR_API_KEY', and performs a lookup for '8.8.8.8'.

```javascript
import IPLocate from 'node-iplocate';

const client = new IPLocate('YOUR_API_KEY');

const result = await client.lookup('8.8.8.8');

// ...
```

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

### Server-side example (Express): /login route

Source: https://www.iplocate.io/docs/guides/detect-hosting-traffic

Shows an Express route that uses IPLocate to check if the client IP is from a hosting provider. Sets 'trust proxy' to ensure req.ip reflects the real client IP behind proxies, and uses the API key from environment variable IPLOCATE_API_KEY.

```javascript
import express from 'express';
import IPLocate from 'node-iplocate';

const app = express();
app.set('trust proxy', true); // ensure req.ip reflects the real client IP behind proxies

const client = new IPLocate(process.env.IPLOCATE_API_KEY);

app.get('/login', async (req, res) => {
  const ip = req.ip;
  const data = await client.lookup(ip);

  if (data.privacy?.is_hosting) {
    // Block, log, throttle, or route differently
  }
  res.send('OK');
});
```

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

### 404 Not Found

Source: https://www.iplocate.io/docs/reference/api-errors

Example error response for a 404 Not Found, indicating the IP address or entity was not found.

```APIDOC
## 404 Not Found

### Description
Returned when the requested IP address or entity is not found.

### Response Example
```json
{
  "error": "Not found"
}
```

### Common Causes
- IP address or entity not found
```

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

### JavaScript Error Handling Example

Source: https://www.iplocate.io/docs/reference/api-errors

Example of handling errors from the IPLocate API using JavaScript's fetch API. It checks the response status, parses error data, and handles rate limiting (429) and authentication errors (401).

```APIDOC
## JavaScript Error Handling Example

### Description
Example of handling errors from the IPLocate API using JavaScript's fetch API. It checks the response status, parses error data, and handles rate limiting (429) and authentication errors (401).

### Code
```javascript
try {
  const response = await fetch('https://iplocate.io/api/lookup/8.8.8.8?apikey=YOUR_API_KEY');

  if (!response.ok) {
    const errorData = await response.json();
    console.error('API Error:', errorData.error);

    switch (response.status) {
      case 429:
        // Handle rate limiting
        const resetDate = new Date(response.headers.get('X-RateLimit-Reset') * 1000);
        console.log(`Rate limited. Try again after ${resetDate.toISOString()}`);
        break;
      case 401:
        // Handle authentication errors
        console.log('Check your API key.');
        break;
      default:
        console.log('Request failed:', response.status);
    }
    return;
  }

  const data = await response.json();
  console.log('Success:', data);

} catch (error) {
  console.error('Network error:', error);
}
```

```

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

### Batch request JSON array of IP addresses

Source: https://www.iplocate.io/docs/ip-intelligence-api/batch-lookup

The request body must be a JSON array of IPv4 or IPv6 addresses. This example shows three addresses.

```json
[
  "8.8.8.8",
  "1.1.1.1",
  "2001:4860:4860::8888"
]
```

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

### Look up an IP address using the MMDB database in Node.js

Source: https://www.iplocate.io/docs/data-feeds/free-ip-to-asn-database

Use this Node.js snippet to perform a local lookup of an IP address against the MMDB database file. It requires the 'mmdb-lib' package (install with 'npm install mmdb-lib') and reads the database file from '/path/to/ip-to-asn.mmdb'. The output shows the ASN information for the IP '104.23.1.8'.

```javascript
import fs from 'fs';
import * as mmdb from 'mmdb-lib'; // npm install mmdb-lib

const db = fs.readFileSync('/path/to/ip-to-asn.mmdb');

const reader = new mmdb.Reader(db);
console.log(reader.get('104.23.1.8'));
// {
//   asn: 132892,
//   country_code: 'US',
//   name: 'CLOUDFLARE',
//   org: 'Cloudflare, Inc.',
//   domain: 'cloudflare.com',
//   network: '104.23.0.0/19'
// }
```

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

### 400 Bad Request

Source: https://www.iplocate.io/docs/reference/api-errors

Example error response for a 400 Bad Request, including common causes.

```APIDOC
## 400 Bad Request

### Description
Returned when the request contains invalid input parameters.

### Response Example
```json
{
  "error": "Invalid IP address"
}
```

### Common Causes
- Malformed IPv4 or IPv6 address format
- If behind a proxy, passing the result of an `X-Forwarded-For` header which may include multiple IP addresses, such as `127.0.0.1, 192.168.1.1`
- Passing an IP address that is `undefined` or `null`
```

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

### Django server-side example for detecting VPNs and proxies

Source: https://www.iplocate.io/docs/guides/detect-vpn-and-proxies

Use this Django view to check the client IP for VPN, proxy, or Tor usage during a checkout flow. It requires the 'iplocate' package and an IPLOCATE_API_KEY environment variable. The helper function extracts the client IP from the X-Forwarded-For header or REMOTE_ADDR. If the privacy flags indicate anonymized traffic, it returns a 202 challenge response.

```python
import os
from django.http import JsonResponse
from django.views.decorators.csrf import csrf_exempt
from iplocate import IPLocateClient

client = IPLocateClient(api_key=os.getenv("IPLOCATE_API_KEY"))

def get_client_ip(request):
    xff = request.META.get("HTTP_X_FORWARDED_FOR")
    if xff:
        ip = xff.split(",")[0].strip()
    else:
        ip = request.META.get("REMOTE_ADDR")
    return ip

@csrf_exempt
def checkout(request):
    ip = get_client_ip(request)
    data = client.lookup(ip)
    if data.privacy and (data.privacy.is_vpn or data.privacy.is_proxy or data.privacy.is_tor):
        return JsonResponse({"action": "challenge", "reason": "anonymized"}, status=202)
    return JsonResponse({"action": "allow"})
```

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

### Express server-side example for detecting VPNs and proxies

Source: https://www.iplocate.io/docs/guides/detect-vpn-and-proxies

Use this Express middleware to check the client IP for VPN, proxy, or Tor usage during a checkout flow. It requires the 'node-iplocate' package and an IPLOCATE_API_KEY environment variable. The 'trust proxy' setting is recommended to correctly obtain the client IP. If the privacy flags indicate anonymized traffic, it returns a 202 challenge response.

```javascript
import express from 'express';
import IPLocate from 'node-iplocate';

const app = express();
app.set('trust proxy', true);

const client = new IPLocate(process.env.IPLOCATE_API_KEY);

app.post('/checkout', async (req, res) => {
  const ip = req.ip; // recommended with trust proxy
  const data = await client.lookup(ip);

  if (data.privacy?.is_vpn || data.privacy?.is_proxy || data.privacy?.is_tor) {
    return res.status(202).json({ action: 'challenge', reason: 'anonymized' });
  }

  return res.json({ action: 'allow' });
});
```

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

### Filter by URL path parameter: single field (country_code)

Source: https://www.iplocate.io/docs/ip-intelligence-api

Returns a single field as plain text. The example fetches country_code for 8.8.8.8 and shows the response 'US'.

```bash
curl "https://iplocate.io/api/lookup/8.8.8.8/country_code"
```

```json
US
```

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

### Filter by URL path parameter: object field (asn)

Source: https://www.iplocate.io/docs/ip-intelligence-api

Returns an object field as JSON. The example fetches ASN information for 8.8.8.8 and shows the full JSON response.

```bash
curl "https://iplocate.io/api/lookup/8.8.8.8/asn"
```

```json
{
  "asn": "AS15169",
  "route": "8.8.8.0/24",
  "netname": "GOOGLE",
  "name": "Google LLC",
  "country_code": "US",
  "domain": "google.com",
  "type": "hosting",
  "rir": "ARIN"
}
```

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

### Look up an IP address with node-iplocate

Source: https://www.iplocate.io/docs/quick-start

Create an IPLocate client with your API key and call lookup('8.8.8.8') to get full JSON data including ip, country, country_code, city, latitude, longitude, privacy, and more.

```javascript
import IPLocate from 'node-iplocate';

const client = new IPLocate('YOUR_API_KEY');
const result = await client.lookup('8.8.8.8');
console.log(result); // full JSON (ip, country, country_code, city, latitude, longitude, privacy, ...)
```

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

### GET /download/:download_name

Source: https://www.iplocate.io/docs/data-feeds

Downloads a database file programmatically using the URL available from your account dashboard. The endpoint requires the download name as a path parameter and supports query parameters for variant and API key.

```APIDOC
## GET /download/:download_name

### Description
Downloads a database file programmatically using the URL available from your account dashboard. The endpoint requires the download name as a path parameter and supports query parameters for variant and API key.

### Method
GET

### Endpoint
https://www.iplocate.io/download/:download_name?variant=_variant_

### Parameters
#### Path Parameters
- **download_name** (string) - Required - The name of the download to retrieve.

#### Query Parameters
- **variant** (string) - Required - The variant of the download to retrieve.
- **apikey** (string) - Required - Your account API key.

### Request Example
```bash
curl --output ip-to-country.mmdb 'https://www.iplocate.io/download/ip-to-country.mmdb?variant=daily&apikey=YOUR_API_KEY'
```

### Response
#### Success Response (200)
- **file** (binary) - The downloaded database file.

#### Response Example
(No explicit response example provided in the source.)
```

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

### Go IPLocate client usage

Source: https://www.iplocate.io/docs/integrations/client-libraries

Create a client with your API key, perform a lookup for 8.8.8.8, handle errors, and print the result.

```go
package main

import (
    "fmt"
    "log"
    "github.com/iplocate/go-iplocate"
)

func main() {
    client := iplocate.NewClient(nil).WithAPIKey("YOUR_API_KEY")
    result, err := client.Lookup("8.8.8.8")
    if err != nil {
        log.Fatal(err)
    }
    fmt.Println(result)
}
```

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

### Get the country code for an IP address

Source: https://www.iplocate.io/docs/quick-start

Use the same client.lookup call and access result.country_code to get the two-letter country code (e.g., US).

```javascript
import IPLocate from 'node-iplocate';

const client = new IPLocate('YOUR_API_KEY');
const result = await client.lookup('8.8.8.8');
console.log(result.country_code); // US
```

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

### Download database with curl using download URL

Source: https://www.iplocate.io/docs/data-feeds

Use this curl command to programmatically download a database file from IPLocate. The URL includes the download name, variant, and your API key. Replace YOUR_API_KEY with your actual key.

```bash
curl --output ip-to-country.mmdb 'https://www.iplocate.io/download/ip-to-country.mmdb?variant=daily&apikey=YOUR_API_KEY'
```

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

### Claude Desktop MCP configuration

Source: https://www.iplocate.io/docs/integrations/mcp-server

Add this JSON to Claude Desktop's Developer settings → Edit Config to enable the IPLocate MCP server. Replace 'your_api_key_here' with your actual API key.

```json
{
  "mcpServers": {
    "iplocate": {
      "command": "npx",
      "args": ["-y", "@iplocate/mcp-server"],
      "env": {
        "IPLOCATE_API_KEY": "your_api_key_here"
      }
    }
  }
}
```

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

### Python Error Handling Example

Source: https://www.iplocate.io/docs/reference/api-errors

Example of handling errors from the IPLocate API using Python's requests library. It checks the response status code, parses error data, and handles rate limiting (429) and authentication errors (401).

```APIDOC
## Python Error Handling Example

### Description
Example of handling errors from the IPLocate API using Python's requests library. It checks the response status code, parses error data, and handles rate limiting (429) and authentication errors (401).

### Code
```python
import requests

try:
    response = requests.get('https://iplocate.io/api/lookup/8.8.8.8', 
                          params={'apikey': 'YOUR_API_KEY'})

    if response.status_code != 200:
        error_data = response.json()
        print(f"API Error: {error_data['error']}")

        if response.status_code == 429:
            print(f"Rate limited. Resets at {response.headers['X-RateLimit-Reset']}")
        elif response.status_code == 401:
            print("Authentication failed. Check API key.")
        return

    data = response.json()
    print(f"Success: {data}")

except requests.RequestException as e:
    print(f"Network error: {e}")
```

```

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

### Node.js IPLocate client usage

Source: https://www.iplocate.io/docs/integrations/client-libraries

Import IPLocate from 'node-iplocate', create a client with your API key, and await a lookup for 8.8.8.8, logging the result.

```javascript
import IPLocate from 'node-iplocate';

const client = new IPLocate('YOUR_API_KEY');
const result = await client.lookup('8.8.8.8');
console.log(result);
```

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

### VS Code (Preview) MCP configuration

Source: https://www.iplocate.io/docs/integrations/mcp-server

Create `.vscode/mcp.json` with this configuration to use the IPLocate MCP server in VS Code. Note the 'servers' key and 'type': 'stdio' field, which differ from other clients.

```json
{
  "servers": {
    "iplocate": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@iplocate/mcp-server"],
      "env": {
        "IPLOCATE_API_KEY": "your_api_key_here"
      }
    }
  }
}
```

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

### 401 Unauthorized

Source: https://www.iplocate.io/docs/reference/api-errors

Example error responses for a 401 Unauthorized, indicating authentication or authorization errors.

```APIDOC
## 401 Unauthorized

### Description
Returned when authentication or authorization fails.

### Response Examples
```json
{
  "error": "Missing API key"
}
```

```json
{
  "error": "Invalid API key"
}
```
```

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

### Not available for free plans error response

Source: https://www.iplocate.io/docs/ip-intelligence-api/batch-lookup

Error response when a free plan without credits attempts a batch lookup.

```json
{
  "error": "Batch lookup is not available for free plans without credits. Please purchase credits at https://iplocate.io/account/credits or sign up to a paid plan."
}
```

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

### curl API lookup for IPv4 and IPv6 addresses

Source: https://www.iplocate.io/docs/reference/ipv4-ipv6

Shows how to call the IPLocate lookup endpoint with an IPv4 and an IPv6 address. Replace YOUR_API_KEY with your actual API key. Both address types work identically.

```bash
# IPv4 lookup
curl "https://iplocate.io/api/lookup/8.8.8.8?apikey=YOUR_API_KEY"

# IPv6 lookup
curl "https://iplocate.io/api/lookup/2001:4860:4860::8888?apikey=YOUR_API_KEY"
```

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

### 429 Too Many Requests

Source: https://www.iplocate.io/docs/reference/api-errors

Example error response for a 429 Too Many Requests, indicating the rate limit has been exceeded.

```APIDOC
## 429 Too Many Requests

### Description
Returned when the rate limit has been exceeded.

### Response Example
```json
{
  "error": "Rate limit exceeded. Please upgrade your plan at iplocate.io/account"
}
```
```

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

### Privacy Object Fields

Source: https://www.iplocate.io/docs/ip-intelligence-api/data-types

Describes the fields of the privacy object returned by the IP Intelligence API, including their meanings and example values.

```APIDOC
## Privacy Object Fields

### Description
This object provides privacy and threat detection data for an IP address, including flags for proxies, VPNs, Tor, iCloud Relay, hosting, bogon addresses, and abuse reports.

### Fields
- **privacy.is_abuser** (boolean) - `true` if the IP address has been reported on an abuse blocklist (e.g., spam, malware).
- **privacy.is_anonymous** (boolean) - Convenience field that is `true` if any of `is_proxy`, `is_tor`, `is_vpn`, or `is_icloud_relay` is true.
- **privacy.is_bogon** (boolean) - `true` if the IP address is a bogon IP address.
- **privacy.is_hosting** (boolean) - `true` if the IP address belongs to a hosting provider or hosts websites/services.
- **privacy.is_icloud_relay** (boolean) - `true` if the IP address belongs to Apple's iCloud Relay service.
- **privacy.is_proxy** (boolean) - `true` if the IP address is a known proxy.
- **privacy.is_tor** (boolean) - `true` if the IP address is a known Tor exit node.
- **privacy.is_vpn** (boolean) - `true` if the IP address is used by a known VPN provider or detected as part of a VPN network.

### Example Response
```json
{
  "privacy": {
    "is_abuser": false,
    "is_anonymous": false,
    "is_bogon": false,
    "is_hosting": true,
    "is_icloud_relay": false,
    "is_proxy": false,
    "is_tor": false,
    "is_vpn": false
  }
}
```
```

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

### Python IPLocate client usage

Source: https://www.iplocate.io/docs/integrations/client-libraries

Create an IPLocateClient with your API key and perform a lookup for 8.8.8.8, printing the country from the result.

```python
from iplocate import IPLocateClient

client = IPLocateClient(api_key="YOUR_API_KEY")
result = client.lookup("8.8.8.8")
print(result.country)
```

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

### GET https://api.iplocate.io/

Source: https://www.iplocate.io/docs/ip-intelligence-api/get-current-ip-free-api

Returns the caller's current IP address as plain text. No authentication or rate limiting is required.

```APIDOC
## GET https://api.iplocate.io/

### Description
Returns the caller's current IP address as plain text. This endpoint is free and unlimited, with no API key required.

### Method
GET

### Endpoint
https://api.iplocate.io/

### Parameters
None

### Request Example
```bash
curl https://api.iplocate.io/
```

### Response
#### Success Response (200)
- **body** (string) - The IP address of the caller, e.g., `123.243.56.78`

#### Response Example
```plain
123.243.56.78
```
```

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

### Batch lookup request with curl

Source: https://www.iplocate.io/docs/ip-intelligence-api/batch-lookup

Sends a POST request to the batch endpoint with a JSON array of IP addresses. Requires a valid API key and a paid plan or credits.

```bash
curl -X POST "https://iplocate.io/api/batch?apikey=YOUR_API_KEY" -H "Content-Type: application/json" -d '["8.8.8.8", "1.1.1.1"]'
```

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

### GET https://api.iplocate.io/json

Source: https://www.iplocate.io/docs/ip-intelligence-api/get-current-ip-free-api

Returns the caller's current IP address in JSON format. This endpoint is free and unlimited, with no API key required.

```APIDOC
## GET https://api.iplocate.io/json

### Description
Returns the caller's current IP address in JSON format. This endpoint is free and unlimited, with no API key required.

### Method
GET

### Endpoint
https://api.iplocate.io/json

### Parameters
None

### Request Example
```bash
curl https://api.iplocate.io/json
```

### Response
#### Success Response (200)
- **ip** (string) - The IP address of the caller, e.g., `123.243.56.78`

#### Response Example
```json
{ "ip": "123.243.56.78" }
```
```

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

### Filter with include parameter: single field

Source: https://www.iplocate.io/docs/ip-intelligence-api

Uses the include query parameter to return a single field as JSON. The example includes country_code for 8.8.8.8.

```bash
curl "https://iplocate.io/api/lookup/8.8.8.8?include=country_code"
```

```json
{
  "country_code": "US"
}
```

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

### hosting object

Source: https://www.iplocate.io/docs/ip-intelligence-api/data-types

The hosting object provides detailed information about the hosting provider or datacenter for an IP address. It is only present when detailed hosting provider information is available.

```APIDOC
## hosting object

### Description
The `hosting` object provides additional detailed information about the type of hosting service or datacenter the IP address belongs to. It is only present if detailed hosting provider information is available; otherwise, `privacy.is_hosting` may be `true` but the `hosting` object will not be included.

### Fields
- **provider** (string) - The name of the hosting provider, e.g., `Amazon AWS`.
- **domain** (string) - The domain name of the hosting provider, e.g., `amazonaws.com`.
- **network** (string) - The network range of the hosting provider.
- **region** (string) - The region code as given by the hosting provider, e.g., `us-east-1`. This field is populated for hosting providers that provide this information; otherwise, it is not present.
- **service** (string) - The name of the service this IP address/network is used for, as given by the hosting provider, e.g., `EC2`. This field is populated for hosting providers that provide this information; otherwise, it is not present.

### Example Response
```json
{
  "hosting": {
    "provider": "Amazon AWS",
    "domain": "aws.amazon.com",
    "network": "3.5.140.0/22",
    "region": "ap-northeast-2",
    "service": "EC2"
  }
}
```

### Major Hosting Providers Detected
IPLocate identifies IP addresses from dozens of major cloud and hosting providers, CDNs, and infrastructure providers, including:
- Amazon Web Services (AWS)
- Microsoft Azure
- Google Cloud Platform (GCP)
- Cloudflare
- Akamai
- Fastly
- DigitalOcean
- Linode (Akamai)
- Hetzner
- OVHcloud

### Regional Information
For major cloud providers, when available, the `region` field may provide the specific geographic region where the resource is located. Examples:
- Amazon Web Services (AWS): us-east-1, eu-west-1, ap-southeast-1, etc.
- Microsoft Azure: East US, West Europe, Southeast Asia, etc.
- Google Cloud Platform (GCP): us-central1, europe-west1, asia-southeast1, etc.

Note that each cloud provider uses different region codes.

### Service Identification
For major cloud providers, the `service` field may identify the specific service or product. Examples:
- Amazon Web Services (AWS): EC2, S3, RDS, Lambda, CloudFront
- Microsoft Azure: Virtual Machines, App Service, SQL Database, Functions
- Google Cloud Platform (GCP): Compute Engine, Cloud Storage, Cloud SQL, Cloud Functions

Note that each cloud provider has different named services.
```

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

### GET /api/lookup/{ip}

Source: https://www.iplocate.io/docs/reference/ipv4-ipv6

Performs an IP address lookup for either an IPv4 or IPv6 address. The endpoint is dual-stacked and supports both address types identically.

```APIDOC
## GET /api/lookup/{ip}

### Description
Performs an IP address lookup for either an IPv4 or IPv6 address. The endpoint is dual-stacked and supports both address types identically.

### Method
GET

### Endpoint
https://iplocate.io/api/lookup/{ip}

### Parameters
#### Path Parameters
- **ip** (string) - Required - The IP address to look up. Can be an IPv4 address (e.g., 8.8.8.8) or an IPv6 address (e.g., 2001:4860:4860::8888).

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

### Request Example
```bash
curl "https://iplocate.io/api/lookup/8.8.8.8?apikey=YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **ip** (string) - The IP address that was looked up.
- **country** (string) - The country name associated with the IP address.
- **country_code** (string) - The ISO country code (e.g., US).
- **is_eu** (boolean) - Whether the IP address is in the European Union.

#### Response Example
```json
{
  "ip": "8.8.8.8",
  "country": "United States",
  "country_code": "US",
  "is_eu": false
}
```
```

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

### GET /api/lookup/:ip

Source: https://www.iplocate.io/docs/ip-intelligence-api/historical-lookup

Retrieves historical IP intelligence data for the specified IP address at a given date. The response format is the same as the standard lookup response.

```APIDOC
## GET /api/lookup/:ip

### Description
Retrieves historical IP intelligence data for the specified IP address at a given date. The response format is the same as the standard lookup response.

### Method
GET

### Endpoint
/api/lookup/:ip

### Parameters
#### Path Parameters
- **ip** (string) - Required - A single IPv4 or IPv6 IP address.

#### Query Parameters
- **at** (string) - Required - A specific date in YYYY-MM-DD format, for example `2024-12-31` for 31 December 2024.
- **apikey** (string) - Required - Your API key.

### Request Example
```bash
curl "https://iplocate.io/api/lookup/8.8.8.8?apikey=YOUR_API_KEY&at=2023-06-15"
```

### Response
#### Success Response (200)
The response is the same as the standard lookup response.

#### Response Example
```json
{
  "ip": "8.8.8.8",
  "country": "United States",
  "country_code": "US",
  // ...
  "asn": {
    // ...
  },
  // ...
}
```
```

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

### Java IPLocate client usage

Source: https://www.iplocate.io/docs/integrations/client-libraries

Create an IPLocateClient with your API key, perform a lookup for 8.8.8.8, and print the country from the response.

```java
import io.iplocate.client.IPLocateClient;
import io.iplocate.client.model.IPLocateResponse;

IPLocateClient client = new IPLocateClient("YOUR_API_KEY");
IPLocateResponse result = client.lookup("8.8.8.8");
System.out.println(result.getCountry());
```

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

### GET /api/lookup/:ip/:filter

Source: https://www.iplocate.io/docs/ip-intelligence-api

Returns a single field or object from the IP lookup response. If the field is a single value, it is returned as plain text; if it is an object, it is returned as JSON.

```APIDOC
## GET /api/lookup/:ip/:filter

### Description
Returns a single field or object from the IP lookup response. If the field is a single value, it is returned as plain text; if it is an object, it is returned as JSON.

### Method
GET

### Endpoint
/api/lookup/:ip/:filter

### Parameters
#### Path Parameters
- **ip** (string) - Required - The IP address to look up.
- **filter** (string) - Required - The field or object to return (e.g., `country_code`, `asn`).

### Request Example
```bash
curl "https://iplocate.io/api/lookup/8.8.8.8/country_code"
```

### Response
#### Success Response (200)
If the field is a single value, it is returned as plain text. If the field is an object, it is returned as JSON.

#### Response Example (single value)
```json
US
```

#### Response Example (object)
```json
{
  "asn": "AS15169",
  "route": "8.8.8.0/24",
  "netname": "GOOGLE",
  "name": "Google LLC",
  "country_code": "US",
  "domain": "google.com",
  "type": "hosting",
  "rir": "ARIN"
}
```
```

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

### PHP IPLocate client usage

Source: https://www.iplocate.io/docs/integrations/client-libraries

Require the Composer autoloader, create an IPLocate client with your API key, perform a lookup for 8.8.8.8, and echo the IP and country from the result.

```php
<?php
require 'vendor/autoload.php';

use IPLocate\IPLocate;

$client = new IPLocate('YOUR_API_KEY');
$result = $client->lookup('8.8.8.8');

echo "IP: {$result->ip}\n";
echo "Country: {$result->country}\n";
```
Tokens:
Raw