IPGeolocation-Logo

IP Geolocation API Client Library/SDK for Python

Overview

The official Python Client Library for IPGeolocation.io's set of APIs, provides a quick, developer friendly, way to access IP Location, Security, Timezone, Astronomy, ASN, Abuse Contact, and useragent data. Lookup your own IP or provide any IPv4, IPv6 or domain name to get structured results in Python, without the need for manual HTTP handling.

  • IP Location API: Get all-in-one unified solution for location (city, locality, state, country, etc.), currency, network (AS number, ASN name, organization, asn type, date of allocation, company/ISP name, company type, company domain), timezone , useragent string parsing, security (threat score, is_tor, is_bot, proxy_provider, cloud_provider), and abuse contact (route/CIDR network, country, address, email, phone numbers) information.
  • IP Security API: Get security, network, location, hostname, timezone and useragent parsing.
  • ASN API: Get ASN details along with peers, upstreams, downstreams, routes, and raw WHOIS.
  • Abuse Contact API: Get abuse emails, phone numbers, kind, organization, route/CIDR network and country.
  • Astronomy API: Get sunrise, sunset, moonrise, moonset, moon phases with precise twilight period times in combination with location information.
  • Timezone API: Get timezone name, multiple time formats, daylight saving status and its details along with location information.
  • Timezone Convert API: Convert time between timezone names, geo coordinates, location addresses, IATA codes, ICAO codes, or UN/LOCODE.
  • User Agent API: Get browser, Operating System, and device info from single or multiple Useragent string parsing.

This library aims to empower developers to integrate threat intelligence, personalization, fraud prevention, compliance, and analytics features directly into Python based applications. Whether you're enriching signup forms with ip geolocation data, localizing content, embedding threat intelligence in back-end systems, or converting time zones and currencies, the library ensures seamless, scalable integration with IPGeolocation.io’s global API infrastructure.

Based on:

  • API version: 2.0.0

Official Release:

Requirements

Installation

1.From PyPI

You can install package directly from using:

(you may need to run pip with root permission: sudo pip install ipgeolocationio )

2.From GitHub

(or append sudo in the start to install the package for all users)

Then import the package:

API Plan Tiers and Documentation

The documentation below corresponds to the four available API tier plans:

For a detailed comparison of what each plan offers, visit the Pricing Page.

API Endpoints

All URIs are relative to https://api.ipgeolocation.io/v2

ClassMethodHTTP requestDescription
IPGeolocationApiget_ip_geolocationGET /ipgeoGet geolocation data for a single IP address
IPGeolocationApiget_bulk_ip_geolocationPOST /ipgeo-bulkGet geolocation data for multiple IP addresses in a single API request
IPSecurityApiget_ip_security_infoGET /securityRetrieve security information (VPN, TOR, proxy, etc.) for a single IP
IPSecurityApiget_bulk_ip_security_infoPOST /security-bulkRetrieve security threat intelligence for multiple IPs
ASNLookupApiget_asn_infoGET /asnGet details of any ASN number or associated IP address
AbuseContactApiget_abuse_contact_infoGET /abuseRetrieve abuse reporting contact information for a given IP address
AstronomyApiget_astronomy_detailsGET /astronomyGet sunrise, sunset, moonrise, moonset, and related data for a location
AstronomyApiget_time_series_lookupGET /astronomy/timeSeriesGet astronomy information for given date range at once
TimezoneApiget_timezone_infoGET /timezoneTimezone information details
TimeConversionApiconvert_time_between_timezonesGET /timezone/convertConvert time between two specified timezones
UserAgentApiget_user_agent_detailsGET /user-agentGet details of user-agent
UserAgentApiparse_user_agent_stringPOST /user-agentHandle single User-Agent string
UserAgentApiparse_bulk_user_agent_stringsPOST /user-agent-bulkHandle multiple user-agent string lookups

Fields and Methods Availability

IP Geolocation offers four plans from billing point of view: Free, Standard, Security, Advance. The availability of each method calling from the respective class, over all plans are presented below.

ClassMethodFreeStandardSecurityAdvance
IPGeolocationApiget_ip_geolocationTickTickCrossTick
IPGeolocationApiget_bulk_ip_geolocationCrossTickCrossTick
IPSecurityApiget_ip_security_infoCrossCrossTickCross
IPSecurityApiget_bulk_ip_security_infoCrossCrossTickCross
ASNLookupApiget_asn_infoCrossCrossCrossTick
AbuseContactApiget_abuse_contact_infoCrossCrossCrossTick
AstronomyApiget_astronomy_detailsTickTickTickTick
AstronomyApiget_time_series_lookupTickTickTickTick
TimezoneApiget_timezone_infoTickTickTickTick
TimeConversionApiconvert_time_between_timezonesTickTickTickTick
UserAgentApiget_user_agent_detailsTickTickTickTick
UserAgentApiparse_user_agent_stringTickTickTickTick
UserAgentApiparse_bulk_user_agent_stringsCrossTickTickTick
Tip

The availability of fields in every API endpoint across all API plans is provided in the Reference Table within each respective API Documentation. e.g., for IPGeolocationApi, please visit https://ipgeolocation.io/ip-location-api.html#reference-to-ipgeolocation-api-response.

Authentication Setup

To authenticate API requests, you need to get an API key from ipgeolocation.io.

1.How to Get Your API Key

  1. Sign up here: https://app.ipgeolocation.io/signup
  2. (optional) Verify your email, if you signed up using email.
  3. Log in to your account: https://app.ipgeolocation.io/login
  4. After logging in, navigate to your Dashboard to find your API key: https://app.ipgeolocation.io/dashboard

2.ApiKeyAuth

Once you've obtained the api key, configure your API client as follows:

The client must configure the authentication and authorization parameters in accordance with the API server security policy.

Important

Uncomment the dotenv part, if you placed the API_KEY in .env file.

Tests

Set the environment variable for API_KEY or specify in .env file and execute pytest to run the tests.

IP Geolocation Examples

This section provides usage examples of the get_ip_geolocation() method from the package across Free, Standard, and Advanced subscription tiers. Each example highlights different combinations of parameters: fields , include , and excludes .

Parameters

  • fields : Use this parameter to include specific fields in the response.
  • excludes : Use this parameter to omit specific fields from the response.
  • include : Use this parameter to add optional modules to the response, such as:
    • security
    • user_agent
    • hostname
    • liveHostname
    • hostnameFallbackLive
    • abuse
    • dma
    • time_zone

For complete details, refer to the official documentation: IP Geolocation API Documentation

The ip parameter in the package can accept any valid IPv4 address, IPv6 address, or domain name. If ip= the parameter is omitted, the API will return information about the public IP address of the device or server where the package is executing.

1.Developer Plan Examples

a.Get Default Fields

Sample Response:

Filtering Specific Fields from the Response (Use of 'exclude' and 'fields')

Sample Response:

2.Standard Plan Examples

a.Get Default Fields

Sample Response:

b.Retrieving Geolocation Data in Multiple Languages

Here is an example to get the geolocation data for IP address '2001:4230:4890::1' in French language:

Sample Response:

c.Include HostName, Timezone and User-Agent

Sample Response:

Note

The IP Geolocation API supports hostname lookup for all paid subscriptions. However, this is not included by default. To enable hostname resolution, use the include parameter with one of the following options:

  • hostname : Performs a quick lookup using the internal hostname database. If no match is found, the IP is returned as-is. This is fast but may produce incomplete results.
  • liveHostname : Queries live sources for accurate hostname resolution. This may increase response time.
  • hostnameFallbackLive : Attempts the internal database first, and falls back to live sources if no result is found. This option provides a balance of speed and reliability.

3.Advanced Plan Examples

a.Include DMA, Abuse and Security

Sample Response:

These examples demonstrate typical usage of the IP Geolocation API with different subscription tiers. Use fields to specify exactly which data to receive, include for optional data like security and user agent, and excludes to omit specific keys from the response.

Note

All features available in the Free plan are also included in the Standard and Advanced plans. Similarly, all features of the Standard plan are available in the Advanced plan.

4.Bulk IP Geolocation Example

The Package also supports bulk IP geolocation requests using the get_bulk_ip_geolocation() method. All parameters like fields , include , and excludes can also be used in bulk requests.

IP Security Examples

This section provides usage examples of the get_ip_security_info() method from the SDK across various subscription tiers. Each example demonstrates different ways to query threat intelligence and risk metadata using parameters like fields, excludes, and optional modules.

For full API specifications, refer to the official IP Security API documentation.

1.Get Default Fields

Sample Response:

2.Include Multiple Optional Fields

Note

You can get all the available fields in standard plan in combination with security data.

3.Request with Field Filtering

Sample Response:

4.Bulk IP Security Request

The SDK also supports bulk IP Security requests using the get_bulk_ip_security_info() method. All parameters like fields , include , and excludes can also be used in bulk requests.

ASN API Examples

This section provides usage examples of the get_asn_info() method from the SDK. These methods allow developers to retrieve detailed ASN-level network data either by ASN number or by IP address.

Note

ASN API is only available in the Advanced Plan

Refer to the ASN API documentation for a detailed list of supported fields and behaviors.

1.Get ASN Information by IP Address

Sample Response:

2.Get ASN Information by ASN Number

Sample Response:

3.Combine All objects using Include

Sample Response:

Abuse Contact API Examples

This section demonstrates how to use the get_abuse_contact_info() method of the AbuseContact API. This API helps security teams, hosting providers, and compliance professionals quickly identify the correct abuse reporting contacts for any IPv4 or IPv6 address. You can retrieve data like the responsible organization, role, contact emails, phone numbers, and address to take appropriate mitigation action against abusive or malicious activity.

Note

Abuse Contact API is only available in the Advanced Plan

Refer to the official Abuse Contact API documentation for details on all available fields.

1.Lookup Abuse Contact by IP

Sample Response:

2.Lookup Abuse Contact with Specific Fields

Sample Response:

3.Lookup Abuse Contact while Excluding Fields

Sample Response:

Timezone API Examples

This section provides usage examples of the get_timezone_info() method from the SDK, showcasing how to fetch timezone and time-related data using different query types — IP address, latitude/longitude, and timezone ID.

For full API specifications, refer to the Timezone API documentation.

1.Get Timezone by IP Address

Sample Response:

2.Get Timezone by Timezone Name

Sample Response:

3.Get Timezone from Any Address

Sample Response:

4.Get Timezone from Location Coordinates

Sample Response:

5.Get Timezone and Airport Details from IATA Code

Sample Response:

Similarly, you can fetch Airport Details and Timezone from using any ICAO code as well

6.Get Timezone and City Details from UN/LOCODE

Sample Response:

Timezone Converter Examples

This section provides usage examples of the convert_time_between_timezones() method from the SDK. The Timezone Converter API allows you to convert a specific time from one timezone to another using timezone identifiers and optional date/time inputs.

For more details, refer to official documentation: Timezone Converter API.

1.Convert Current Time from One Timezone to Another

Sample Response:

Similarly, you can convert time from any timezone to another timezone using location coordinates (Latitude and Longitude), location addresses, IATA codes, ICAO codes and UN/LUCODE .

User Agent API Examples

This section provides usage examples of the parse_user_agent_string() method from the SDK. The User Agent API extracts and classifies information from user agent strings, including browser, engine, device, OS, and type metadata.

For full explanation, visit the User Agent API documentation.

1.Parse a Basic User Agent String

Sample Response:

If you don't pass any userAgentString, the API will return the data of device's user agent.

Bulk User Agent Parsing Example

The SDK also supports bulk User Agent parsing using the parse_bulk_user_agent_strings() method. This allows parsing multiple user agent strings in a single request. All fields available in single-user-agent parsing are returned per entry.

Astronomy API Examples

This section provides usage examples of the get_astronomy_details() method from the SDK, allowing developers to fetch sun and moon timings and position data based on coordinates, IP, or location string.

Refer to the official Astronomy API documentation for more details.

1.Lookup Astronomy API by Coordinates

Sample Response:

2.Lookup Astronomy API by IP Address

Sample Response:

3.Lookup Astronomy API by Location String

Sample Response:

4.Lookup Astronomy API for a Specific Date

Sample Response:

5.Lookup Location info in Different Language

You can also get Astronomy Data in other languages as well. Only paid subscriptions can access this feature.

Sample Response:

Documentation For Models

Subscribe Our Newsletter

Get the latest in geolocation tech, straight to your inbox.