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:

• Available on Go Packages
• Source Code: GitHub Repository

Table of Contents

1. Requirements
2. Installation
3. API Plan Tiers and Documentation
4. API Endpoints
5. Fields and Methods Availability
6. Authentication Setup
   • How to Get Your API Key
   • ApiKeyAuth
7. Custom HTTP Client Timeout
8. Accessing Fields in Response Models
   • Recommended: Use Getter Methods
   • Want to Use Struct Fields
   • Applies to All Models
9. IP Geolocation Examples
   • Developer (Free) Plan Examples
   • Standard Plan Examples
   • Advanced Plan Examples
   • Bulk IP Geolocation Example
10. IP Security Examples
    • Get Default Security Info
    • Include Multiple Optional Fields
    • Request with Field Filtering
    • Bulk IP Security Request
11. ASN API Examples
    • Get ASN Information by IP Address
    • Get ASN Information by ASN Number
    • Combine All objects using Include
12. Abuse Contact API Examples
    • Lookup Abuse Contact by IP
    • Lookup Abuse Contact with Specific Fields
    • Lookup Abuse Contact while Excluding Fields
13. Timezone API Examples
    • Get Timezone by IP Address
    • Get Timezone by Timezone Name
    • Get Timezone from Any Address
    • Get Timezone from Location Coordinates
    • Get Timezone and Airport Details from IATA Code
    • Get Timezone and City Details from UN/LOCODE
14. Timezone Converter Examples
    • Convert Current Time from One Timezone to Another
15. User Agent API Examples
    • Parse a Basic User Agent String
    • Bulk User Agent Parsing Example
16. Astronomy API Examples
    • Lookup Astronomy by Coordinates
    • Lookup Astronomy by IP Address
    • Lookup Astronomy by Location String
    • Lookup Astronomy for Specific Date
    • Lookup Location Info in Different Language
17. Documentation for Models

Requirements

• Go 1.18+
• API Key from IPGeolocation.io

Installation

Install the following dependencies:

go get github.com/IPGeolocation/ip-geolocation-go-sdk

API Plan Tiers and Documentation

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

• Developer Plan (Free): Full Documentation
• Standard Plan: Full Documentation
• Advance Plan: Full Documentation
• Security Plan: Full Documentation

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

Class	Method	HTTP request	Description
IPGeolocationAPI	GetIpGeolocation	Get /ipgeo	Get geolocation data for a single IP address
IPGeolocationAPI	GetBulkIpGeolocation	Post /ipgeo-bulk	Get geolocation data for multiple IP addresses
IPSecurityAPI	GetIpSecurityInfo	Get /security	Get threat intelligence for a single IP address
IPSecurityAPI	GetBulkIpSecurityInfo	Post /security-bulk	Get threat intelligence for multiple IP addresses
ASNLookupAPI	GetAsnInfo	Get /asn	Get details of any ASN number
AbuseContactAPI	GetAbuseContactInfo	Get /abuse	Retrieve abuse contact data for an IP address
AstronomyAPI	GetAstronomyDetails	Get /astronomy	Get sun and moon timings and positions
TimezoneAPI	GetTimezoneInfo	Get /timezone	Get timezone information based on IP, coordinates, or name
TimeConversionAPI	ConvertTimeBetweenTimezones	Get /timezone/convert	Convert time from one timezone to another
UserAgentAPI	GetUserAgentDetails	Get /user-agent	Parse a single user-agent string
UserAgentAPI	ParseBulkUserAgentStrings	Post /user-agent-bulk	Parse 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.

Class	Method	Free	Standard	Security	Advance
IPGeolocationAPI	GetIpGeolocation	✔	✔	✖	✔
IPGeolocationAPI	GetBulkIpGeolocation	✖	✔	✖	✔
IPSecurityAPI	GetIpSecurityInfo	✖	✖	✔	✖
IPSecurityAPI	GetBulkIpSecurityInfo	✖	✖	✔	✖
ASNLookupAPI	GetAsnInfo	✖	✖	✖	✔
AbuseContactAPI	GetAbuseContactInfo	✖	✖	✖	✔
AstronomyAPI	GetAstronomyDetails	✔	✔	✔	✔
TimezoneAPI	GetTimezoneInfo	✔	✔	✔	✔
TimeConversionAPI	ConvertTimeBetweenTimezones	✔	✔	✔	✔
UserAgentAPI	GetUserAgentDetails	✔	✔	✔	✔
UserAgentAPI	ParseBulkUserAgentStrings	✖	✔	✔	✔

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.

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

ApiKeyAuth

Once, you are done with getting your API Key, you may pass it as follows:

import (
"context"
"fmt"
ipgeolocation "github.com/IPGeolocation/ip-geolocation-go-sdk/sdk"
"log"
)

ctx := ipgeolocation.WithAPIKey(context.Background(), "<YOUR_API_KEY>")
configuration := ipgeolocation.NewConfiguration()
apiClient := ipgeolocation.NewAPIClient(configuration)

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.

import (
    "net/http"
    "time"
)

configuration := ipgeolocationsdk.NewConfiguration()

// Set custom timeout of 5 seconds
configuration.HTTPClient = &http.Client{
    Timeout: 5 * time.Second,
}

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

Recommended Approach: Use Getter Methods

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

resp, _, err := apiClient.IPGeolocationAPI.
	GetIpGeolocation(ctx).
	Ip("8.8.8.8").
	Execute()

if err != nil {
	log.Fatalf("Error fetching IP details: %v", err)
}

// Safely access values
fmt.Println("IP:", resp.GetIp())
fmt.Println("City:", resp.Location.GetCity())

These getter methods will:

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

If You Still Want to Use Struct Fields

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

if resp.Ip != nil {
	fmt.Println("IP:", *resp.Ip)
}

if resp.Location != nil && resp.Location.City != nil {
	fmt.Println("City:", *resp.Location.City)
}

Note

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

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.

Developer (Free) Plan Examples

Get Default Fields

respGeolocation, res, err := apiClient.IPGeolocationAPI.
	GetIpGeolocation(ctx).
	Ip("8.8.8.8").
	Execute()

if err != nil {
	fmt.Fprintf(os.Stderr, "Error calling `IPGeolocationAPI.GetIpGeolocation`: %v\n", err)
	if res != nil {
		fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
	}
	return
}

responseJson, _ := json.MarshalIndent(respGeolocation, "", "  ")
fmt.Println(string(responseJson))

Sample Response:

{
  "ip": "8.8.8.8",
  "location": {
    "city": "Mountain View",
    "continent_code": "NA",
    "continent_name": "North America",
    "country_capital": "Washington, D.C.",
    "country_code2": "US",
    "country_code3": "USA",
    "country_emoji": "🇺🇸",
    "country_flag": "https://ipgeolocation.io/static/flags/us_64.png",
    "country_name": "United States",
    "country_name_official": "United States of America",
    "district": "Santa Clara",
    "geoname_id": "6301403",
    "is_eu": false,
    "latitude": "37.42240",
    "longitude": "-122.08421",
    "state_code": "US-CA",
    "state_prov": "California",
    "zipcode": "94043-1351"
  }
  "country_metadata": {
    "calling_code": "+1",
    "languages": [
      "en-US",
      "es-US",
      "haw",
      "fr"
    ],
    "tld": ".us"
  },
  "currency": {
    "code": "USD",
    "name": "US Dollar",
    "symbol": "$"
  },
}

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

respGeolocation, res, err := apiClient.IPGeolocationAPI.
		GetIpGeolocation(ctx).
		Ip("8.8.8.8").
		Fields("location").
		Excludes("location.continent_code,location.continent_name").
		Execute()

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error calling `IPGeolocationAPI.GetIpGeolocation`: %v\n", err)
		if res != nil {
			fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
		}
		return
	}

	responseJson, _ := json.MarshalIndent(respGeolocation, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "ip": "8.8.8.8",
  "location": {
    "city": "Mountain View",
    "country_capital": "Washington, D.C.",
    "country_code2": "US",
    "country_code3": "USA",
    "country_emoji": "🇺🇸",
    "country_flag": "https://ipgeolocation.io/static/flags/us_64.png",
    "country_name": "United States",
    "country_name_official": "United States of America",
    "district": "Santa Clara",
    "geoname_id": "6301403",
    "is_eu": false,
    "latitude": "37.42240",
    "longitude": "-122.08421",
    "state_code": "US-CA",
    "state_prov": "California",
    "zipcode": "94043-1351"
  }
}

Standard Plan Examples

Get Default Fields

respGeolocation, res, err := apiClient.IPGeolocationAPI.
	GetIpGeolocation(ctx).
	Ip("8.8.8.8").
	Execute()

if err != nil {
	fmt.Fprintf(os.Stderr, "Error calling `IPGeolocationAPI.GetIpGeolocation`: %v\n", err)
	if res != nil {
		fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
	}
	return
}

responseJson, _ := json.MarshalIndent(respGeolocation, "", "  ")
fmt.Println(string(responseJson))

Sample Response:

{
  "ip": "8.8.8.8",
  "location": {
    "continent_code": "NA",
    "continent_name": "North America",
    "country_code2": "US",
    "country_code3": "USA",
    "country_name": "United States",
    "country_name_official": "United States of America",
    "country_capital": "Washington, D.C.",
    "state_prov": "California",
    "state_code": "US-CA",
    "district": "Santa Clara",
    "city": "Mountain View",
    "zipcode": "94043-1351",
    "latitude": "37.42240",
    "longitude": "-122.08421",
    "is_eu": false,
    "country_flag": "https://ipgeolocation.io/static/flags/us_64.png",
    "geoname_id": "6301403",
    "country_emoji": "\uD83C\uDDFA\uD83C\uDDF8"
  },
  "country_metadata": {
    "calling_code": "\u002B1",
    "tld": ".us",
    "languages": [
      "en-US",
      "es-US",
      "haw",
      "fr"
    ]
  },
  "network": {
    "asn": {
      "as_number": "AS15169",
      "organization": "Google LLC",
      "country": "US"
    },
    "company": {
      "name": "Google LLC"
    }
  },
  "currency": {
    "code": "USD",
    "name": "US Dollar",
    "symbol": "$"
  }
}

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:

respGeolocation, res, err := apiClient.IPGeolocationAPI.
	GetIpGeolocation(ctx).
	Ip("2001:4230:4890::1").
	Lang("fr").
	Execute()

if err != nil {
	fmt.Fprintf(os.Stderr, "Error calling `IPGeolocationAPI.GetIpGeolocation`: %v\n", err)
	if res != nil {
		fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
	}
	return
}

responseJson, _ := json.MarshalIndent(respGeolocation, "", "  ")
fmt.Println(string(responseJson))

Sample Response:

{
  "ip": "2001:4230:4890:0:0:0:0:1",
  "location": {
    "continent_code": "AF",
    "continent_name": "Afrique",
    "country_code2": "MU",
    "country_code3": "MUS",
    "country_name": "Maurice",
    "country_name_official": "",
    "country_capital": "Port Louis",
    "state_prov": "Wilhems des plaines",
    "state_code": "MU-PW",
    "district": "Quatre Bornes",
    "city": "Quatre Bornes",
    "zipcode": "72201",
    "latitude": "-20.24304",
    "longitude": "57.49631",
    "is_eu": false,
    "country_flag": "https://ipgeolocation.io/static/flags/mu_64.png",
    "geoname_id": "1106777",
    "country_emoji": "\uD83C\uDDF2\uD83C\uDDFA"
  },
  "country_metadata": {
    "calling_code": "\u002B230",
    "tld": ".mu",
    "languages": [
      "en-MU",
      "bho",
      "fr"
    ]
  },
  "network": {
    "asn": {
      "as_number": "AS0",
      "organization": "",
      "country": ""
    },
    "company": {
      "name": "African Network Information Center AfriNIC Ltd"
    }
  },
  "currency": {
    "code": "MUR",
    "name": "Mauritius Rupee",
    "symbol": "\u20A8"
  }
}

Include HostName, Timezone and User-Agent

configuration.UserAgent = "User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9"
apiClient := ipgeolocation.NewAPIClient(configuration)
respGeolocation, res, err := apiClient.IPGeolocationAPI.
	GetIpGeolocation(ctx).
	Ip("4.5.6.7").
	Fields("location.country_name,location.country_capital").
    Include("user_agent, time_zone, hostnameFallbackLive").
	Execute()

if err != nil {
	fmt.Fprintf(os.Stderr, "Error calling `IPGeolocationAPI.GetIpGeolocation`: %v\n", err)
	if res != nil {
		fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
	}
	return
}

responseJson, _ := json.MarshalIndent(respGeolocation, "", "  ")
fmt.Println(string(responseJson))

Sample Response

{
  "ip": "4.5.6.7",
  "hostname": "4.5.6.7",
  "location": {
    "country_capital": "Washington, D.C.",
    "country_name": "United States"
  },
  "time_zone": {
    "name": "America/Chicago",
    "offset": -6,
    "offset_with_dst": -6,
    "current_time": "2025-12-03 00:10:05.484-0600",
    "current_time_unix": 1764742205.484,
    "current_tz_abbreviation": "CST",
    "current_tz_full_name": "Central Standard Time",
    "standard_tz_abbreviation": "CST",
    "standard_tz_full_name": "Central Standard Time",
    "is_dst": false,
    "dst_savings": 0,
    "dst_exists": true,
    "dst_tz_abbreviation": "CDT",
    "dst_tz_full_name": "Central Daylight Time",
    "dst_start": {
      "utc_time": "2025-03-09 TIME 08",
      "duration": "+1H",
      "gap": true,
      "date_time_after": "2025-03-09 TIME 03",
      "date_time_before": "2025-03-09 TIME 02",
      "overlap": false
    },
    "dst_end": {
      "utc_time": "2025-11-02 TIME 07",
      "duration": "-1H",
      "gap": false,
      "date_time_after": "2025-11-02 TIME 01",
      "date_time_before": "2025-11-02 TIME 02",
      "overlap": true
    }
  },
  "user_agent": {
    "user_agent_string": "User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9",
    "name": "Safari",
    "type": "Browser",
    "version": "9.0.2",
    "version_major": "9",
    "device": {
      "name": "Apple Macintosh",
      "type": "Desktop",
      "brand": "Apple",
      "cpu": "Intel"
    },
    "engine": {
      "name": "AppleWebKit",
      "type": "Browser",
      "version": "601.3.9",
      "version_major": "601"
    },
    "operating_system": {
      "name": "Mac OS",
      "type": "Desktop",
      "version": "10.11.2",
      "version_major": "10.11",
      "build": "??"
    }
  }
}

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.

Advanced Plan Example

Include DMA, Abuse, and Security

respGeolocation, res, err := apiClient.IPGeolocationAPI.
		GetIpGeolocation(ctx).
		Ip("8.8.8.8").
		Include("dma, abuse, security").
		Execute()

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error calling `IPGeolocationAPI.GetIpGeolocation`: %v\n", err)
		if res != nil {
		    fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
		}
		return
	}

	responseJson, _ := json.MarshalIndent(respGeolocation, "", "  ")
	fmt.Println(string(responseJson))

Sample Response:

{
  "ip": "8.8.8.8",
  "location": {
    "continent_code": "NA",
    "continent_name": "North America",
    "country_code2": "US",
    "country_code3": "USA",
    "country_name": "United States",
    "country_name_official": "United States of America",
    "country_capital": "Washington, D.C.",
    "state_prov": "California",
    "state_code": "US-CA",
    "district": "Santa Clara",
    "city": "Mountain View",
    "zipcode": "94043-1351",
    "latitude": "37.42240",
    "longitude": "-122.08421",
    "is_eu": false,
    "geoname_id": "6301403",
    "accuracy_radius": "",
    "locality": "Mountain View",
    "dma_code": "807"
  },
  "country_metadata": {
    "calling_code": "\u002B1",
    "tld": ".us",
    "languages": [
      "en-US",
      "es-US",
      "haw",
      "fr"
    ]
  },
  "network": {
    "asn": {
      "as_number": "AS15169",
      "organization": "Google LLC",
      "country": "US",
      "asn_name": "GOOGLE",
      "type": "BUSINESS",
      "domain": "about.google",
      "date_allocated": "",
      "allocation_status": "assigned",
      "num_of_ipv4_routes": "991",
      "num_of_ipv6_routes": "104",
      "rir": "ARIN"
    },
    "connection_type": "",
    "company": {
      "name": "Google LLC",
      "type": "",
      "domain": ""
    }
  },
  "currency": {
    "code": "USD",
    "name": "US Dollar",
    "symbol": "$"
  },
  "security": {
    "threat_score": 0,
    "is_tor": false,
    "is_proxy": false,
    "proxy_type": "",
    "proxy_provider": "",
    "is_anonymous": false,
    "is_known_attacker": false,
    "is_spam": false,
    "is_bot": false,
    "is_cloud_provider": false,
    "cloud_provider": ""
  },
  "abuse": {
    "route": "8.8.8.0/24",
    "country": "",
    "handle": "ABUSE5250-ARIN",
    "name": "Abuse",
    "organization": "Abuse",
    "role": "abuse",
    "kind": "group",
    "address": "1600 Amphitheatre Parkway\nMountain View\nCA\n94043\nUnited States",
    "emails": [
      "network-abuse@google.com"
    ],
    "phone_numbers": [
      "\u002B1-650-253-0000"
    ]
  }
}

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.

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.

respGeolocation, res, err := apiClient.IPGeolocationAPI.
	GetBulkIpGeolocation(ctx).
	Ips([]string{"8.8.8.8", "asdasdasd"}).
	Include("security,time_zone,user_agent,abuse,dma,hostname").
	Execute()

if err != nil {
	fmt.Fprintf(os.Stderr, "Error when calling `SecurityAPI.GetSecurityInfo`: %v\n", err)
	fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
	return
}

 // full JSON response
responseJson, _ := json.MarshalIndent(respGeolocation, "", "  ")
fmt.Println(string(responseJson))

// Loop through results and check for errors
for _, item := range respGeolocation {
	if item.IsError() { // Check for error response
		fmt.Println("❌", item.ErrorResponse.GetMessage())
	} else { //GeolocationResponse
		fmt.Println("✅", item.GeolocationResponse.GetIp())
	}
}

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.

Get Default Security Info

respSecurity, res, err := apiClient.IPSecurityAPI.GetIpSecurityInfo(ctx).Ip("2.56.188.34").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SecurityAPI.GetSecurityInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
		return
	}

	responseJson, _ := json.MarshalIndent(respSecurity, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "ip": "2.56.188.34",
  "security": {
    "threat_score": 80,
    "is_tor": false,
    "is_proxy": true,
    "proxy_type": "VPN",
    "proxy_provider": "Nord VPN",
    "is_anonymous": true,
    "is_known_attacker": true,
    "is_spam": false,
    "is_bot": false,
    "is_cloud_provider": true,
    "cloud_provider": "Packethub S.A."
  }
}

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.

configuration.UserAgent = "User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9"
apiClient := ipgeolocation.NewAPIClient(configuration)
respSecurity, res, err := apiClient.IPSecurityAPI.
		GetIpSecurityInfo(ctx).
		Ip("2.56.188.34").
		Include("location,network,currency,time_zone,user_agent,country_metadata,hostname").
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SecurityAPI.GetSecurityInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
		return
	}

	responseJson, _ := json.MarshalIndent(respSecurity, "", "  ")
	fmt.Println(string(responseJson))

Note

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

Request with Field Filtering

respSecurity, res, err := apiClient.IPSecurityAPI.
		GetIpSecurityInfo(ctx).
		Ip("2.56.188.34").
		Fields("security.is_tor,security.is_proxy,security.is_bot,security.is_spam").
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SecurityAPI.GetSecurityInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
		return
	}

	responseJson, _ := json.MarshalIndent(respSecurity, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "ip": "195.154.221.54",
  "security": {
    "is_tor": false,
    "is_proxy": true,
    "is_spam": false,
    "is_bot": false
  }
}

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.

respSecurity, r, err := apiClient.IPSecurityAPI.GetBulkIpSecurityInfo(ctx).Ips([]string{"8.8.8.8", "asdasd"}).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SecurityAPI.GetSecurityInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "API error response: %v\n", res.Body)
		return
	}

	responseJson, _ := json.MarshalIndent(respSecurity, "", "  ")
	fmt.Println(string(responseJson))

	for _, item := range respSecurity {
		if item.IsError() {
			fmt.Println(*item.Error.Message)
		} else {
			fmt.Println(*item.SecurityResponse.Security.IsAnonymous)
		}
	}

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.

Get ASN Information by IP Address

respASN, r, err := apiClient.ASNLookupAPI.
		GetAsnInfo(ctx).Ip("8.8.8.8").
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ASNAPI.GetASNInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respASN, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "ip": "8.8.8.8",
  "asn": {
    "as_number": "AS15169",
    "organization": "Google LLC",
    "country": "US",
    "asn_name": "GOOGLE",
    "type": "BUSINESS",
    "domain": "about.google",
    "date_allocated": "",
    "allocation_status": "assigned",
    "num_of_ipv4_routes": "991",
    "num_of_ipv6_routes": "104",
    "rir": "ARIN"
  }
}

Get ASN Information by ASN Number

respASN, r, err := apiClient.ASNLookupAPI.
		GetAsnInfo(ctx).Asn(15169).
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ASNAPI.GetASNInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respASN, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "asn": {
    "as_number": "AS15169",
    "organization": "Google LLC",
    "country": "US",
    "asn_name": "GOOGLE",
    "type": "BUSINESS",
    "domain": "about.google",
    "date_allocated": "",
    "allocation_status": "assigned",
    "num_of_ipv4_routes": "991",
    "num_of_ipv6_routes": "104",
    "rir": "ARIN"
  }
}

Combine All objects using Include

respASN, r, err := apiClient.ASNLookupAPI.
		GetAsnInfo(ctx).Asn(12).
		Include("peers,downstreams,upstreams,routes,whois_response").
		Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ASNAPI.GetASNInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respASN, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "asn": {
    "as_number": "AS12",
    "organization": "New York University",
    "country": "US",
    "asn_name": "NYU-DOMAIN",
    "type": "EDUCATION",
    "domain": "nyu.edu",
    "date_allocated": "",
    "allocation_status": "assigned",
    "num_of_ipv4_routes": "12",
    "num_of_ipv6_routes": "1",
    "rir": "ARIN",
    "routes": [
      "192.76.177.0/24",
      "216.165.96.0/20",
      "...",
      "216.165.120.0/22"
    ],
    "upstreams": [
      {
        "as_number": "AS3269",
        "description": "Telecom Italia S.p.A.",
        "country": "IT"
      },
      "...",
      {
        "as_number": "AS137",
        "description": "Consortium GARR",
        "country": "IT"
      }
    ],
    "downstreams": [
      {
        "as_number": "AS394666",
        "description": "NYU Langone Health",
        "country": "US"
      },
      {
        "as_number": "AS54965",
        "description": "Polytechnic Institute of NYU",
        "country": "US"
      }
    ],
    "peers": [
      {
        "as_number": "AS3269",
        "description": "Telecom Italia S.p.A.",
        "country": "IT"
      },
      "...",
      {
        "as_number": "AS54965",
        "description": "Polytechnic Institute of NYU",
        "country": "US"
      }
    ],
    "whois_response": "<raw-whois-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.

Lookup Abuse Contact by IP

respAbuse, res, err := apiClient.AbuseContactAPI.GetAbuseContactInfo(ctx).
		Ip("1.0.0.0").
		Execute()

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AbuseAPI.GetAbuseDetails` with full params: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", res)
		return
	}

	responseJson, _ := json.MarshalIndent(respAbuse, "", "  ")
	fmt.Println(string(responseJson))

Sample Response:

{
  "ip": "1.0.0.0",
  "abuse": {
    "route": "1.0.0.0/24",
    "country": "AU",
    "handle": "IRT-APNICRANDNET-AU",
    "name": "IRT-APNICRANDNET-AU",
    "organization": "",
    "role": "abuse",
    "kind": "group",
    "address": "PO Box 3646\nSouth Brisbane, QLD 4101\nAustralia",
    "emails": [
      "helpdesk@apnic.net"
    ],
    "phone_numbers": [
      "\u002B61 7 3858 3100"
    ]
  }
}

Lookup Abuse Contact with Specific Fields

respAbuse, res, err := apiClient.AbuseContactAPI.GetAbuseContactInfo(ctx).
		Ip("1.2.3.4").
		Fields("abuse.role,abuse.emails").
		Execute()

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AbuseAPI.GetAbuseDetails` with full params: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", res)
		return
	}

	responseJson, _ := json.MarshalIndent(respAbuse, "", "  ")
	fmt.Println(string(responseJson))

Sample Response:

{
  "ip": "1.2.3.4",
  "abuse": {
    "role": "abuse",
    "emails": [
      "helpdesk@apnic.net"
    ]
  }
}

Lookup Abuse Contact while Excluding Fields

respAbuse, res, err := apiClient.AbuseContactAPI.GetAbuseContactInfo(ctx).
		Ip("9.9.9.9").
		Excludes("abuse.handle,abuse.emails").
		Execute()

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AbuseAPI.GetAbuseDetails` with full params: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", res)
		return
	}

	responseJson, _ := json.MarshalIndent(respAbuse, "", "  ")
	fmt.Println(string(responseJson))

Sample Response:

{
  "ip": "9.9.9.9",
  "abuse": {
    "route": "9.9.9.0/24",
    "country": "",
    "name": "Quad9 Abuse",
    "organization": "Quad9 Abuse",
    "role": "abuse",
    "kind": "group",
    "address": "1442 A Walnut Street Ste 501\nBerkeley\nCA\n94709\nUnited States",
    "phone_numbers": [
      "\u002B1-415-831-3129"
    ]
  }
}

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.

Get Timezone by IP Address

respTimezone, r, err := apiClient.TimezoneAPI.GetTimezoneInfo(ctx).Ip("8.8.8.8").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TimezoneAPI.GetTimezoneInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}
	
	responseJson, _ := json.MarshalIndent(respTimezone, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "ip": "8.8.8.8",
  "location": {
    "continent_code": "NA",
    "continent_name": "North America",
    "country_code2": "US",
    "country_code3": "USA",
    "country_name": "United States",
    "country_name_official": "United States of America",
    "is_eu": false,
    "state_prov": "California",
    "state_code": "US-CA",
    "district": "Santa Clara",
    "city": "Mountain View",
    "locality": null,
    "zipcode": "94043-1351",
    "latitude": "37.42240",
    "longitude": "-122.08421"
  },
  "time_zone": {
    "name": "America/Los_Angeles",
    "offset": -8,
    "offset_with_dst": -7,
    "date": "2025-07-28T00:00:00+00:00",
    "date_time": "2025-07-28 02:52:42",
    "date_time_txt": "Monday, July 28, 2025 02:52:42",
    "date_time_wti": "Mon, 28 Jul 2025 02:52:42 -0700",
    "date_time_ymd": "2025-07-28T09:52:42+00:00",
    "date_time_unix": 1753696362.031,
    "time_24": "02:52:42",
    "time_12": "02:52:42 AM",
    "week": 31,
    "month": 7,
    "year": 2025,
    "year_abbr": "25",
    "is_dst": true,
    "dst_savings": 1,
    "dst_exists": true,
    "dst_start": {
      "utc_time": "2025-03-09 TIME 10",
      "duration": "\u002B1H",
      "gap": true,
      "date_time_after": "2025-03-09 TIME 03",
      "date_time_before": "2025-03-09 TIME 02",
      "overlap": false
    },
    "dst_end": {
      "utc_time": "2025-11-02 TIME 09",
      "duration": "-1H",
      "gap": false,
      "date_time_after": "2025-11-02 TIME 01",
      "date_time_before": "2025-11-02 TIME 02",
      "overlap": true
    }
  }
}

Note

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

Get Timezone by Timezone Name

respTimezone, r, err := apiClient.TimezoneAPI.GetTimezoneInfo(ctx).Tz("Europe/London").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TimezoneAPI.GetTimezoneInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respTimezone, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "time_zone": {
    "name": "Europe/London",
    "offset": 0,
    "offset_with_dst": 1,
    "date": "2025-07-28T00:00:00+00:00",
    "date_time": "2025-07-28 11:05:31",
    "date_time_txt": "Monday, July 28, 2025 11:05:31",
    "date_time_wti": "Mon, 28 Jul 2025 11:05:31 \u002B0100",
    "date_time_ymd": "2025-07-28T10:05:31+00:00",
    "date_time_unix": 1753697131.049,
    "time_24": "11:05:31",
    "time_12": "11:05:31 AM",
    "week": 31,
    "month": 7,
    "year": 2025,
    "year_abbr": "25",
    "is_dst": true,
    "dst_savings": 1,
    "dst_exists": true,
    "dst_start": {
      "utc_time": "2025-03-30 TIME 01",
      "duration": "\u002B1H",
      "gap": true,
      "date_time_after": "2025-03-30 TIME 02",
      "date_time_before": "2025-03-30 TIME 01",
      "overlap": false
    },
    "dst_end": {
      "utc_time": "2025-10-26 TIME 01",
      "duration": "-1H",
      "gap": false,
      "date_time_after": "2025-10-26 TIME 01",
      "date_time_before": "2025-10-26 TIME 02",
      "overlap": true
    }
  }
}

Get Timezone from Any Address

respTimezone, r, err := apiClient.TimezoneAPI.GetTimezoneInfo(ctx).Location("Munich, Germany").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TimezoneAPI.GetTimezoneInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respTimezone, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "location": {
    "location_string": "Munich, Germany",
    "country_name": "Germany",
    "state_prov": "Bavaria",
    "city": "Munich",
    "locality": "",
    "latitude": "48.13711",
    "longitude": "11.57538"
  },
  "time_zone": {
    "name": "Europe/Berlin",
    "offset": 1,
    "offset_with_dst": 2,
    "date": "2025-07-28T00:00:00+00:00",
    "date_time": "2025-07-28 12:07:45",
    "date_time_txt": "Monday, July 28, 2025 12:07:45",
    "date_time_wti": "Mon, 28 Jul 2025 12:07:45 \u002B0200",
    "date_time_ymd": "2025-07-28T10:07:45+00:00",
    "date_time_unix": 1753697265.804,
    "time_24": "12:07:45",
    "time_12": "12:07:45 PM",
    "week": 31,
    "month": 7,
    "year": 2025,
    "year_abbr": "25",
    "is_dst": true,
    "dst_savings": 1,
    "dst_exists": true,
    "dst_start": {
      "utc_time": "2025-03-30 TIME 01",
      "duration": "\u002B1H",
      "gap": true,
      "date_time_after": "2025-03-30 TIME 03",
      "date_time_before": "2025-03-30 TIME 02",
      "overlap": false
    },
    "dst_end": {
      "utc_time": "2025-10-26 TIME 01",
      "duration": "-1H",
      "gap": false,
      "date_time_after": "2025-10-26 TIME 02",
      "date_time_before": "2025-10-26 TIME 03",
      "overlap": true
    }
  }
}

Get Timezone from Location Coordinates

respTimezone, r, err := apiClient.TimezoneAPI.GetTimezoneInfo(ctx).Lat(48.8566).Long(2.3522).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TimezoneAPI.GetTimezoneInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respTimezone, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "time_zone": {
    "name": "Europe/Paris",
    "offset": 1,
    "offset_with_dst": 2,
    "date": "2025-07-28T00:00:00+00:00",
    "date_time": "2025-07-28 12:11:05",
    "date_time_txt": "Monday, July 28, 2025 12:11:05",
    "date_time_wti": "Mon, 28 Jul 2025 12:11:05 \u002B0200",
    "date_time_ymd": "2025-07-28T10:11:05+00:00",
    "date_time_unix": 1753697465.681,
    "time_24": "12:11:05",
    "time_12": "12:11:05 PM",
    "week": 31,
    "month": 7,
    "year": 2025,
    "year_abbr": "25",
    "is_dst": true,
    "dst_savings": 1,
    "dst_exists": true,
    "dst_start": {
      "utc_time": "2025-03-30 TIME 01",
      "duration": "\u002B1H",
      "gap": true,
      "date_time_after": "2025-03-30 TIME 03",
      "date_time_before": "2025-03-30 TIME 02",
      "overlap": false
    },
    "dst_end": {
      "utc_time": "2025-10-26 TIME 01",
      "duration": "-1H",
      "gap": false,
      "date_time_after": "2025-10-26 TIME 02",
      "date_time_before": "2025-10-26 TIME 03",
      "overlap": true
    }
  }
}

Get Timezone and Airport Details from IATA Code

respTimezone, r, err := apiClient.TimezoneAPI.GetTimezoneInfo(ctx).IataCode("ZRH").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TimezoneAPI.GetTimezoneInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respTimezone, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "airport_details": {
    "type": "large_airport",
    "name": "Zurich Airport",
    "latitude": "47.45806",
    "longitude": "8.54806",
    "elevation_ft": 1417,
    "continent_code": "EU",
    "country_code": "CH",
    "state_code": "CH-ZH",
    "city": "Zurich",
    "iata_code": "ZRH",
    "icao_code": "LSZH",
    "faa_code": ""
  },
  "time_zone": {
    "name": "Europe/Zurich",
    "offset": 1,
    "offset_with_dst": 2,
    "date": "2025-07-28T00:00:00+00:00",
    "date_time": "2025-07-28 12:13:14",
    "date_time_txt": "Monday, July 28, 2025 12:13:14",
    "date_time_wti": "Mon, 28 Jul 2025 12:13:14 \u002B0200",
    "date_time_ymd": "2025-07-28T10:13:14+00:00",
    "date_time_unix": 1753697594.724,
    "time_24": "12:13:14",
    "time_12": "12:13:14 PM",
    "week": 31,
    "month": 7,
    "year": 2025,
    "year_abbr": "25",
    "is_dst": true,
    "dst_savings": 1,
    "dst_exists": true,
    "dst_start": {
      "utc_time": "2025-03-30 TIME 01",
      "duration": "\u002B1H",
      "gap": true,
      "date_time_after": "2025-03-30 TIME 03",
      "date_time_before": "2025-03-30 TIME 02",
      "overlap": false
    },
    "dst_end": {
      "utc_time": "2025-10-26 TIME 01",
      "duration": "-1H",
      "gap": false,
      "date_time_after": "2025-10-26 TIME 02",
      "date_time_before": "2025-10-26 TIME 03",
      "overlap": true
    }
  }
}

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

Get Timezone and City Details from UN/LOCODE

respTimezone, r, err := apiClient.TimezoneAPI.GetTimezoneInfo(ctx).LoCode("ESBCN").Execute()
if err != nil {
	fmt.Fprintf(os.Stderr, "Error when calling `TimezoneAPI.GetTimezoneInfo`: %v\n", err)
	fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	return
}

responseJson, _ := json.MarshalIndent(respTimezone, "", "  ")
fmt.Println(string(responseJson))

Sample Response

{
  "lo_code_details": {
    "lo_code": "ESBCN",
    "city": "Barcelona",
    "state_code": "",
    "country_code": "ES",
    "country_name": "",
    "location_type": "Port, Rail Terminal, Road Terminal, Airport, Postal Exchange",
    "latitude": "41.38289",
    "longitude": "2.17743"
  },
  "location": null,
  "time_zone": {
    "name": "Europe/Madrid",
    "offset": 1,
    "offset_with_dst": 2,
    "date": "2025-07-28T00:00:00+00:00",
    "date_time": "2025-07-28 12:17:35",
    "date_time_txt": "Monday, July 28, 2025 12:17:35",
    "date_time_wti": "Mon, 28 Jul 2025 12:17:35 \u002B0200",
    "date_time_ymd": "2025-07-28T10:17:35+00:00",
    "date_time_unix": 1753697855.438,
    "time_24": "12:17:35",
    "time_12": "12:17:35 PM",
    "week": 31,
    "month": 7,
    "year": 2025,
    "year_abbr": "25",
    "is_dst": true,
    "dst_savings": 1,
    "dst_exists": true,
    "dst_start": {
      "utc_time": "2025-03-30 TIME 01",
      "duration": "\u002B1H",
      "gap": true,
      "date_time_after": "2025-03-30 TIME 03",
      "date_time_before": "2025-03-30 TIME 02",
      "overlap": false
    },
    "dst_end": {
      "utc_time": "2025-10-26 TIME 01",
      "duration": "-1H",
      "gap": false,
      "date_time_after": "2025-10-26 TIME 02",
      "date_time_before": "2025-10-26 TIME 03",
      "overlap": true
    }
  }
}

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.

Convert Current Time from One Timezone to Another

respTimeConversion, res, err := apiClient.TimeConversionAPI.ConvertTimeBetweenTimezones(ctx).
		TzFrom("America/New_York").
		TzTo("Asia/Tokyo").
		Execute()

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error calling `TimeConversionAPI.ConvertTimeBetweenTimezones`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", res)
		return
	}
	responseJson, _ := json.MarshalIndent(respTimeConversion, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "original_time": "2025-07-28 06:37:29",
  "converted_time": "2025-07-28 19:37:29",
  "diff_hour": 13,
  "diff_min": 780
}

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.

Parse a Basic User Agent String

respUserAgent, r, err := apiClient.UserAgentAPI.GetUserAgentDetails(ctx).UserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UserAgentAPI.GetUserAgentDetails`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respUserAgent, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "user_agent_string": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36",
  "name": "Chrome",
  "type": "Browser",
  "version": "125",
  "version_major": "125",
  "device": {
    "name": "Desktop",
    "type": "Desktop",
    "brand": "Unknown",
    "cpu": "Intel x86_64"
  },
  "engine": {
    "name": "Blink",
    "type": "Browser",
    "version": "125",
    "version_major": "125"
  },
  "operating_system": {
    "name": "Windows NT",
    "type": "Desktop",
    "version": "??",
    "version_major": "??",
    "build": "??"
  }
}

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.

respBulkUserAgents, r, err := apiClient.UserAgentAPI.ParseBulkUserAgentStrings(ctx).UserAgents([]string{"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9"}).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UserAgentAPI.ParseBulkUserAgentStrings`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}
	responseJson, _ := json.MarshalIndent(respBulkUserAgents, "", "  ")
	fmt.Println(string(responseJson))

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.

Lookup Astronomy Info by Coordinates

respAstronomy, r, err := apiClient.AstronomyAPI.GetAstronomyDetails(ctx).Lat("40.71280").Long("-74.00084").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AstronomyAPI.GetAstronomyDetails`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respAstronomy, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "location": {
    "country_name": "",
    "state_prov": "New York",
    "city": "New York",
    "locality": "",
    "latitude": "40.71280",
    "longitude": "-74.00600",
    "elevation": "6"
  },
  "astronomy": {
    "date": "2025-07-28",
    "current_time": "07:39:25.857",
    "mid_night": "01:02",
    "night_end": "03:56",
    "morning": {
      "astronomical_twilight_begin": "03:56",
      "astronomical_twilight_end": "04:39",
      "nautical_twilight_begin": "04:39",
      "nautical_twilight_end": "05:18",
      "civil_twilight_begin": "05:18",
      "civil_twilight_end": "05:48",
      "blue_hour_begin": "05:05",
      "blue_hour_end": "05:30",
      "golden_hour_begin": "05:30",
      "golden_hour_end": "06:28"
    },
    "sunrise": "05:48",
    "sunset": "20:15",
    "evening": {
      "golden_hour_begin": "19:36",
      "golden_hour_end": "20:34",
      "blue_hour_begin": "20:34",
      "blue_hour_end": "20:58",
      "civil_twilight_begin": "20:15",
      "civil_twilight_end": "20:46",
      "nautical_twilight_begin": "20:46",
      "nautical_twilight_end": "21:24",
      "astronomical_twilight_begin": "21:24",
      "astronomical_twilight_end": "22:07"
    },
    "night_begin": "22:07",
    "sun_status": "-",
    "solar_noon": "13:02",
    "day_length": "14:26",
    "sun_altitude": 19.00187046130002,
    "sun_distance": 151931858.71621194,
    "sun_azimuth": 81.1108254930794,
    "moon_phase": "WAXING_CRESCENT",
    "moonrise": "09:49",
    "moonset": "22:20",
    "moon_status": "-",
    "moon_altitude": -22.545016457413194,
    "moon_distance": 392992.5364140531,
    "moon_azimuth": 63.49091214788473,
    "moon_parallactic_angle": -42.81395612950803,
    "moon_illumination_percentage": "14.63",
    "moon_angle": 44.97239607122072
  }
}

Lookup Astronomy API by IP Address

respAstronomy, r, err := apiClient.AstronomyAPI.GetAstronomyDetails(ctx).Ip("8.8.8.8").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AstronomyAPI.GetAstronomyDetails`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respAstronomy, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "ip": "8.8.8.8",
  "location": {
    "continent_code": "NA",
    "continent_name": "North America",
    "country_code2": "US",
    "country_code3": "USA",
    "country_name": "United States",
    "country_name_official": "United States of America",
    "is_eu": false,
    "state_prov": "California",
    "state_code": "US-CA",
    "district": "Santa Clara",
    "city": "Mountain View",
    "locality": "Charleston Terrace",
    "zipcode": "94043-1351",
    "latitude": "37.42240",
    "longitude": "-122.08421",
    "elevation": "3"
  },
  "astronomy": {
    "date": "2025-07-28",
    "current_time": "04:41:26.394",
    "mid_night": "01:15",
    "night_end": "04:26",
    "morning": {
      "astronomical_twilight_begin": "04:26",
      "astronomical_twilight_end": "05:04",
      "nautical_twilight_begin": "05:04",
      "nautical_twilight_end": "05:40",
      "civil_twilight_begin": "05:40",
      "civil_twilight_end": "06:09",
      "blue_hour_begin": "05:29",
      "blue_hour_end": "05:52",
      "golden_hour_begin": "05:52",
      "golden_hour_end": "06:46"
    },
    "sunrise": "06:09",
    "sunset": "20:19",
    "evening": {
      "golden_hour_begin": "19:42",
      "golden_hour_end": "20:37",
      "blue_hour_begin": "20:37",
      "blue_hour_end": "21:00",
      "civil_twilight_begin": "20:19",
      "civil_twilight_end": "20:48",
      "nautical_twilight_begin": "20:48",
      "nautical_twilight_end": "21:24",
      "astronomical_twilight_begin": "21:24",
      "astronomical_twilight_end": "22:03"
    },
    "night_begin": "22:03",
    "sun_status": "-",
    "solar_noon": "13:14",
    "day_length": "14:10",
    "sun_altitude": -15.671101747287796,
    "sun_distance": 151931858.71621194,
    "sun_azimuth": 50.4143830554159,
    "moon_phase": "WAXING_CRESCENT",
    "moonrise": "10:10",
    "moonset": "22:35",
    "moon_status": "-",
    "moon_altitude": -48.28723721558242,
    "moon_distance": 392998.88399571925,
    "moon_azimuth": 12.524793229334932,
    "moon_parallactic_angle": -9.936777293515336,
    "moon_illumination_percentage": "14.64",
    "moon_angle": 44.98851599731005
  }
}

Lookup Astronomy API by Location String

respAstronomy, r, err := apiClient.AstronomyAPI.GetAstronomyDetails(ctx).Location("Milan, Italy").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AstronomyAPI.GetAstronomyDetails`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respAstronomy, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "location": {
    "location_string": "Milan, Italy",
    "country_name": "Italy",
    "state_prov": "Lombardy",
    "city": "Milan",
    "locality": "",
    "latitude": "45.46419",
    "longitude": "9.18963",
    "elevation": "122"
  },
  "astronomy": {
    "date": "2025-07-28",
    "current_time": "13:42:58.799",
    "mid_night": "01:30",
    "night_end": "03:51",
    "morning": {
      "astronomical_twilight_begin": "03:51",
      "astronomical_twilight_end": "04:44",
      "nautical_twilight_begin": "04:44",
      "nautical_twilight_end": "05:28",
      "civil_twilight_begin": "05:28",
      "civil_twilight_end": "06:00",
      "blue_hour_begin": "05:14",
      "blue_hour_end": "05:42",
      "golden_hour_begin": "05:42",
      "golden_hour_end": "06:45"
    },
    "sunrise": "06:00",
    "sunset": "20:58",
    "evening": {
      "golden_hour_begin": "20:13",
      "golden_hour_end": "21:17",
      "blue_hour_begin": "21:17",
      "blue_hour_end": "21:44",
      "civil_twilight_begin": "20:58",
      "civil_twilight_end": "21:30",
      "nautical_twilight_begin": "21:30",
      "nautical_twilight_end": "22:14",
      "astronomical_twilight_begin": "22:14",
      "astronomical_twilight_end": "23:06"
    },
    "night_begin": "23:06",
    "sun_status": "-",
    "solar_noon": "13:29",
    "day_length": "14:57",
    "sun_altitude": 63.24708973645173,
    "sun_distance": 151931858.71621192,
    "sun_azimuth": 186.94038709300645,
    "moon_phase": "WAXING_CRESCENT",
    "moonrise": "09:57",
    "moonset": "22:45",
    "moon_status": "-",
    "moon_altitude": 35.48879898890679,
    "moon_distance": 393003.74957552383,
    "moon_azimuth": 127.97070506514478,
    "moon_parallactic_angle": -33.63951797483762,
    "moon_illumination_percentage": "14.65",
    "moon_angle": 45.000873301539855
  }
}

Lookup Astronomy API for Specific Date

respAstronomy, r, err := apiClient.AstronomyAPI.GetAstronomyDetails(ctx).Lat("-27.47").Long("153.03").Date("2025-01-01").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AstronomyAPI.GetAstronomyDetails`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respAstronomy, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "location": {
    "country_name": "Australia",
    "state_prov": "Queensland",
    "city": "Brisbane",
    "locality": "Brisbane",
    "latitude": "-27.47000",
    "longitude": "153.02000",
    "elevation": ""
  },
  "astronomy": {
    "date": "2025-01-01",
    "current_time": "21:46:06.454",
    "mid_night": "23:51",
    "night_end": "03:24",
    "morning": {
      "astronomical_twilight_begin": "03:24",
      "astronomical_twilight_end": "03:57",
      "nautical_twilight_begin": "03:57",
      "nautical_twilight_end": "04:29",
      "civil_twilight_begin": "04:29",
      "civil_twilight_end": "04:56",
      "blue_hour_begin": "04:19",
      "blue_hour_end": "04:40",
      "golden_hour_begin": "04:40",
      "golden_hour_end": "05:30"
    },
    "sunrise": "04:56",
    "sunset": "18:46",
    "evening": {
      "golden_hour_begin": "18:12",
      "golden_hour_end": "19:02",
      "blue_hour_begin": "19:02",
      "blue_hour_end": "19:23",
      "civil_twilight_begin": "18:46",
      "civil_twilight_end": "19:13",
      "nautical_twilight_begin": "19:13",
      "nautical_twilight_end": "19:45",
      "astronomical_twilight_begin": "19:45",
      "astronomical_twilight_end": "20:18"
    },
    "night_begin": "20:18",
    "sun_status": "-",
    "solar_noon": "11:51",
    "day_length": "13:50",
    "sun_altitude": -31.17124718523727,
    "sun_distance": 147102938.88036567,
    "sun_azimuth": 214.0841443735061,
    "moon_phase": "NEW_MOON",
    "moonrise": "05:42",
    "moonset": "20:08",
    "moon_status": "-",
    "moon_altitude": -17.39121672394405,
    "moon_distance": 380326.07103959366,
    "moon_azimuth": 229.56204420965753,
    "moon_parallactic_angle": 132.1947921694531,
    "moon_illumination_percentage": "2.78",
    "moon_angle": 19.20715172104959
  }
}

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.

respAstronomy, r, err := apiClient.AstronomyAPI.GetAstronomyDetails(ctx).Ip("1.1.1.1").Lang("fr").Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AstronomyAPI.GetAstronomyDetails`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
		return
	}

	responseJson, _ := json.MarshalIndent(respAstronomy, "", "  ")
	fmt.Println(string(responseJson))

Sample Response

{
  "ip": "1.1.1.1",
  "location": {
    "location_string": null,
    "continent_code": "OC",
    "continent_name": "Oc\u00E9anie",
    "country_code2": "AU",
    "country_code3": "AUS",
    "country_name": "Australie",
    "country_name_official": "",
    "is_eu": false,
    "state_prov": "Queensland",
    "state_code": "AU-QLD",
    "district": "Brisbane",
    "city": "Brisbane Sud",
    "locality": "",
    "zipcode": "4101",
    "latitude": "-27.47306",
    "longitude": "153.01421",
    "elevation": ""
  },
  "astronomy": {
    "date": "2025-07-28",
    "current_time": "21:49:02.623",
    "mid_night": "23:54",
    "...": "",
    "moon_angle": 45.04952396653247
  }
}

Documentation For Models

• ASNConnection
• ASNResponse
• ASNDetails
• Abuse
• AbuseResponse
• Astronomy
• AstronomyEvening
• AstronomyLocation
• AstronomyMorning
• AstronomyResponse
• BulkIpSecurity
• BulkIPGeolocation
• CountryMetadata
• Currency
• ErrorResponse
• GeolocationResponse
• GetBulkIpGeolocationRequest
• Location
• LocationMinimal
• Network
• NetworkAsn
• NetworkCompany
• NetworkMinimal
• NetworkMinimalAsn
• NetworkMinimalCompany
• ParseBulkUserAgentStringsRequest
• ParseUserAgentStringRequest
• Security
• SecurityAPIResponse
• TimeZone
• TimeZoneDetailedResponse
• TimeZoneDstEnd
• TimeZoneDstStart
• TimezoneAirport
• TimezoneDetail
• TimezoneDetailDstEnd
• TimezoneDetailDstStart
• TimezoneLocation
• TimezoneLocode
• UserAgentData
• UserAgentDataDevice
• UserAgentDataEngine
• UserAgentDataOperatingSystem