pricing background

IP Geolocation Database Documentation

IP to Country Snapshots

The endpoint accepts a date parameter to download the snapshot for a specific day and provides a ZIP archive containing multiple .gz files that act like a modular database. Each file holds specific datasets like abuse details, ASN information, country metadata, and place names linked together by IDs. The ip-to-country-db.csv file serves as the central mapping, connecting IPs to countries with confidence scores, ASN IDs, and abuse references.

Authorization

You can make authorized requests to our API by passing API key as a query parameter. To get your API key, login to our billing dashboard and get your API key! If your API key has been compromised, you can change it by clicking on reset button in billing dashboard.

Query Parameters

Required
  • apiKey
    Get your API key from our billing dashboard.
  • date
    Use the date parameter in yyyy-MM-dd (2026-01-26) format to get the snapshot of that day.

Request

shellnodejsjavapythonphprubyjscsharpgocswiftjquery
SHELL
Loading request...

Response

Loading response...

Status Codes

Success Codes
  • 200  Request is processed successfully.
Failure Codes
  • 400  Please pass apiKey param value.
  • 400  Please pass date parameter
  • 400  Invalid date parameter
  • 401  Api record not found.
  • 401  Provided API key is inactive.
  • 401  Please buy database subscription.
  • 401  Your database subscription plan is inactive.
  • 401  You cannot download file.
  • 401  You have exceeded the download limit of 20000.
  • 401  Suspicious Activity.
  • 404  File is not available of this date.
  • 413  Please upgrade your plans.

IP to Country Snapshot Status

Use the endpoint to get the status of the latest IP to Country snapshot. The JSON output contains the snapshot name, creation date, and expected deletion date.

Authorization

You can make authorized requests to our API by passing API key as a query parameter. To get your API key, login to our billing dashboard and get your API key! If your API key has been compromised, you can change it by clicking on reset button in billing dashboard.

Query Parameters

Required
  • apiKey
    Get your API key from our billing dashboard.

Request

shellnodejsjavapythonphprubyjscsharpgocswiftjquery
SHELL
Loading request...

Response

Loading response...

Status Codes

Success Codes
  • 200  Request is processed successfully.
Failure Codes
  • 400  Please pass apiKey param value.
  • 401  Api record not found.
  • 401  Provided API key is inactive.
  • 401  You cannot download file.
  • 401  You have exceeded the download limit of 20000.
  • 401  Suspicious Activity.
  • 413  Please upgrade your plans.

IP to City Snapshots

The endpoint lets you specify a date parameter to fetch a snapshot for that day. It delivers a ZIP archive containing several .gz files, each holding different datasets such as abuse records, ASN information, country metadata, place names, and company details. At the core of the archive is ip-to-city-db.csv, which provides district and state-level mappings enriched with attributes like accuracy radius, geo-name IDs, latitude, and longitude.

Authorization

You can make authorized requests to our API by passing API key as a query parameter. To get your API key, login to our billing dashboard and get your API key! If your API key has been compromised, you can change it by clicking on reset button in billing dashboard.

Query Parameters

Required
  • apiKey
    Get your API key from our billing dashboard.
  • date
    Use the date parameter in yyyy-MM-dd (2026-01-26) format to get the snapshot of that day.

Request

shellnodejsjavapythonphprubyjscsharpgocswiftjquery
SHELL
Loading request...

Response

Loading response...

Status Codes

Success Codes
  • 200  Request processed successfully.
Failure Codes
  • 400  Please pass apiKey param value.
  • 400  Please pass date parameter
  • 400  Invalid date parameter
  • 401  Api record not found.
  • 401  Provided API key is inactive.
  • 401  Please buy database subscription.
  • 401  Your database subscription plan is inactive.
  • 401  You cannot download file.
  • 401  You have exceeded the download limit of 20000.
  • 401  Suspicious Activity.
  • 404  File is not available of this date.
  • 413  Please upgrade your plans.

IP to City Snapshot Status

Use the endpoint to get the status of the latest IP to City snapshot. The JSON output contains the snapshot name, creation date, and expected deletion date.

Authorization

You can make authorized requests to our API by passing API key as a query parameter. To get your API key, login to our billing dashboard and get your API key! If your API key has been compromised, you can change it by clicking on reset button in billing dashboard.

Query Parameters

Required
  • apiKey
    Get your API key from our billing dashboard.

Request

shellnodejsjavapythonphprubyjscsharpgocswiftjquery
SHELL
Loading request...

Response

Loading response...

Status Codes

Success Codes
  • 200  Request processed successfully.
Failure Codes
  • 400  Please pass apiKey param value.
  • 401  Api record not found.
  • 401  Provided API key is inactive.
  • 401  You cannot download file.
  • 401  You have exceeded the download limit of 20000.
  • 401  Suspicious Activity.
  • 413  Please upgrade your plans.