IPGeolocation-Logo

Go API client for IPGeolocation.io

Overview

The official Go Client Library/SDK for IPGeolocation.io's set of APIs, provides a quick, developer friendly, way to access IP Location, threat intelligence, Timezone, Astronomy, ASN, Abuse Contact, and user-agent data. Lookup your own IP or provide any IPv4, IPv6 or domain name to get structured results in Go, without the need for manual HTTP handling or custom JSON unmarshalling.

  • 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: Parse browser, Operating System, and device info from single or multiple user-agent strings.

This SDK enables developers to integrate threat intelligence, fraud Detection, compliance, analytics features and Timezone API capabilities directly into Go applications. Whether you're enriching sign-up forms with IP geolocation data, detecting fraudulent traffic, embedding threat intelligence in backend services, or automating time zone conversions and localization, the library delivers fast, and scalable integration with IPGeolocation.io’s global API infrastructure.

Based on:

  • API version: 2.0.0

Official Release:

Requirements

Installation

Install the following dependencies:

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.

Documentation For API Endpoints

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

ClassMethodHTTP requestDescription
IPGeolocationAPIGetIpGeolocationGet /ipgeoGet geolocation data for a single IP address
IPGeolocationAPIGetBulkIpGeolocationPost /ipgeo-bulkGet geolocation data for multiple IP addresses
IPSecurityAPIGetIpSecurityInfoGet /securityGet threat intelligence for a single IP address
IPSecurityAPIGetBulkIpSecurityInfoPost /security-bulkGet threat intelligence for multiple IP addresses
ASNLookupAPIGetAsnInfoGet /asnGet details of any ASN number
AbuseContactAPIGetAbuseContactInfoGet /abuseRetrieve abuse contact data for an IP address
AstronomyAPIGetAstronomyDetailsGet /astronomyGet sun and moon timings and positions
TimezoneAPIGetTimezoneInfoGet /timezoneGet timezone information based on IP, coordinates, or name
TimeConversionAPIConvertTimeBetweenTimezonesGet /timezone/convertConvert time from one timezone to another
UserAgentAPIGetUserAgentDetailsGet /user-agentParse a single user-agent string
UserAgentAPIParseBulkUserAgentStringsPost /user-agent-bulkParse multiple user-agent strings

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
IPGeolocationAPIGetIpGeolocationTickTickCrossTick
IPGeolocationAPIGetBulkIpGeolocationCrossTickCrossTick
IPSecurityAPIGetIpSecurityInfoCrossCrossTickCross
IPSecurityAPIGetBulkIpSecurityInfoCrossCrossTickCross
ASNLookupAPIGetAsnInfoCrossCrossCrossTick
AbuseContactAPIGetAbuseContactInfoCrossCrossCrossTick
AstronomyAPIGetAstronomyDetailsTickTickTickTick
TimezoneAPIGetTimezoneInfoTickTickTickTick
TimeConversionAPIConvertTimeBetweenTimezonesTickTickTickTick
UserAgentAPIGetUserAgentDetailsTickTickTickTick
UserAgentAPIParseBulkUserAgentStringsCrossTickTickTick
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

The API key for your IPGeolocation account is required for all requests.

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 are done with getting your API Key, you may pass it as follows:

Custom HTTP Client Timeout

You can configure the SDK to use a custom HTTP client — useful for setting timeouts, proxies, or other advanced behaviors.

Here's an example to set a custom timeout of 5 seconds for the API call.

Accessing Fields in Response Models

When working with responses returned by the SDK, most fields are represented as pointers ( *string , *int , or custom types like *Location ). This allows for precise nullability handling, but it also means that:

  • You can't access values like resp.Ip directly without dereferencing ( *resp.Ip )
  • This can lead to verbose or error-prone code if not handled properly

1.Recommended Approach: Use Getter Methods

All response models include GetX() methods for safe, nil-checked access.

These getter methods will:

  • Return the value directly if it’s present
  • Return the zero value ( "" , 0 , etc.) if the pointer is nil

2.If You Still Want to Use Struct Fields

You can directly access struct fields using pointer dereferencing, but you must check for nil:

Note

This approach can panic if you skip nil checks, so it's recommended only if you need more control.

3.Applies to All Models

This pattern of using *Type fields + GetX() methods applies across all models in the SDK, including:

  • IpGeolocation
  • Location
  • Timezone etc.

Wherever you see fields like *string or *Location , you can use the corresponding .GetField() method for safe and clean access.

Tip

A whole list of all models is provided here.

IP Geolocation Examples

This section provides usage examples of the getIPGeolocation() method from the SDK 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 SDK can accept any valid IPv4 address, IPv6 address, or domain name. If the Ip() method is not used or the parameter is omitted, the API will return information about the public IP address of the device or server where the SDK is executed.

1.Developer (Free) 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 Example

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 SDK also supports bulk IP geolocation requests using the getBulkIpGeolocation() 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 GetIpSecurityInfo() 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 Security Info

Sample Response

2.Include Multiple Optional Fields

This example shows how to include additional modules like location, network, currency, time_zone, etc., to enrich the response with more context.

Note

You can get all the available fields in standard plan in combination with security data, when subscribed to security plan.

3.Request with Field Filtering

Sample Response

4.Bulk IP Security Request

The SDK also supports bulk IP Security requests using the GetBulkIpSecurityInfo() 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 getAsnDetails() method from the SDK. These methods allow developers to retrieve detailed ASN-level network data either by ASN number or by IP address. Note that ASN API is only available in the Advanced subscription plans.

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

Note

ASN API is only available on the Advanced subscription plans.

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 GetAbuseContactInfo() 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 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 GetTimezoneInfo() 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

Note

The Time Zone API is available to all users. However, multi-language support is only available for paid users.

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 ConvertTimeBetweenTimezones() 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

You can convert time from any timezone to another using:

  • Coordinate (latitude & longitude)
  • Locations (city or address)
  • IATA codes
  • ICAO codes
  • UN/LOCODE

Simply provide the appropriate source and target parameters in the method.

User Agent API Examples

This section provides usage examples of the GetUserAgentDetails() method from the SDK. The User Agent API extracts and modelifies 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 ParseBulkUserAgentStrings() 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 GetAstronomyDetails() 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 Info 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 Specific Date

Sample Response

5.Lookup Location Info in Different Language

You can also get Astronomy related location 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.