Documentation

API Reference

Everything you need to integrate IP geolocation into your application. Get started in minutes with our simple REST API.

🚀

Quick Start

Get up and running in 2 minutes

🔗

Endpoints

API endpoints reference

⚙️

Parameters

Available data fields

💻

Code Examples

Ready-to-use snippets

Quick Start

Make your first API call in seconds. Our REST API returns JSON responses and requires only your API key for authentication.

1

Get Your API Key

Sign up for free to get your API key. Start with a free 30-day trial.

2

Make Your First Request

Use any HTTP client to call our API. Here's a simple example:

# Get location data for any IP
curl "http://0.0.0.0:8080/YOUR_API_KEY/8.8.8.8"

# Response
{
  "success": true,
  "connection": {
    "ip": "8.8.8.8",
    "ip_version": "4"
  },
  "location": {
    "country": {
      "name": "United States",
      "alpha_2": "US"
    },
    "city": "Mountain View"
  }
}

API Endpoints

All endpoints return JSON responses. Authentication is done via API key in the URL.

GETDetect Current IP
http://0.0.0.0:8080/YOUR_API_KEY/detect

Automatically detects and returns location data for the requesting IP address.

GETLookup Specific IP
http://0.0.0.0:8080/YOUR_API_KEY/8.8.8.8

Returns location data for a specific IPv4 or IPv6 address.

GETWith Include Parameter
http://0.0.0.0:8080/YOUR_API_KEY/detect?include=city,country_name

Use the include parameter to request only specific fields and reduce response size.

Available Parameters

Use the include query parameter to select which fields to return. Separate multiple fields with commas.

Location Data

city"Brooklyn"
capital"Washington D.C."
country_name"United States"
country_alpha_2"US"
country_alpha_3"USA"
country_emoji"🇺🇸"
country_subdivision"New York"
country_subdivision_id"NY"
country_zip_code"11205"

Geographic Data

continent_code"NA"
continent_name"North America"
location_latitude40.6955
location_longitude-73.9667
time_zone"America/New_York"

Additional Data

ip"161.185.160.93"
ip_version4
country_eu_memberfalse
country_dialing_code["1"]
currency_code["USD"]

Security Data

is_proxyfalse
is_torfalse
proxy_typenull

Full Response Example

Here's a complete API response with all available fields.

JSON Response
{
  "success": true,
  "connection": {
    "ip": "161.185.160.93",
    "ip_version": "4"
  },
  "location": {
    "capital": "Washington D.C.",
    "city": "New York",
    "continent": {
      "code": "NA",
      "name": "North America"
    },
    "country": {
      "alpha_2": "US",
      "alpha_3": "USA",
      "dialing_code": ["1"],
      "emoji": "🇺🇸",
      "eu_member": false,
      "name": "United States",
      "subdivision": "New York",
      "subdivision_id": "NY",
      "zip_code": "10003"
    },
    "latitude": 40.7359,
    "longitude": -73.9904
  },
  "security": {
    "is_proxy": false,
    "is_tor": false,
    "proxy_type": null
  },
  "time": {
    "zone": "America/New_York"
  },
  "currency": {
    "code": ["USD", "USN", "USS"]
  }
}

Code Examples

Copy and paste these examples to get started quickly in your preferred language.

# Get location data for any IP
curl "http://0.0.0.0:8080/YOUR_API_KEY/8.8.8.8"

Ready to get started?

Create your free account and start your 30-day free trial.

Get Your API Key →