ip-geolocation-api-sdk-typescript

v2.0.1

Published

23 days ago

Official Typescript SDK for IPGeolocation.io. Effortlessly integrate IP Geolocation, IP Security, Timezone, ASN, Astronomy, User Agent, Abuse Contact, and Timezone Conversion APIs into your Node.js applications.

0High
0Medium
0Low

ejazahmed

ipgeolocation typescript sdk ipgeolocation typescript sdk ipgeolocation sdk ipgeolocation-sdk-ts

IP Geolocation API Typescript SDK

IPGeolocation provides a set of APIs to make IP-based decisions and enrich your applications with real-time geolocation, timezone, user-agent, and threat intelligence data.

API version: 2.0
Package version: 2.0.0 NPM package: ip-geolocation-api-sdk-typescript

Installation

Using NPM

Install the SDK directly from NPM:

npm install ip-geolocation-api-sdk-typescript

Using Yarn

Alternatively, if you use Yarn:

yarn add ip-geolocation-api-sdk-typescript

Manual Installation

To include the SDK manually:

Clone this repository:

git clone https://github.com/ipgeolocation/ip-geolocation-api-typescript-sdk.git

Navigate to the project folder and install dependencies:

npm install

or with Yarn:

yarn install

Authentication Setup

To authenticate API requests, you'll need an API key from ipgeolocation.io. Once you have the key, initialize the SDK client with it:

import { Configuration } from "ip-geolocation-api-sdk-typescript";

const configuration = new Configuration({
    apiKey: "YOUR_API_KEY",

});

API Endpoints

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

Class | Method | HTTP request | Description ------------ |-----------------------------------------------------------------------------------------| ------------- | ------------- 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 IPGeolocationAPI | getBulkIpGeolocation | POST /ipgeo-bulk | Get geolocation data for multiple IP addresses IPGeolocationAPI | getIpGeolocation | GET /ipgeo | Get geolocation data for a single IP address IPSecurityAPI | getBulkIpSecurityInfo | POST /security-bulk | Get threat intelligence for multiple IP addresses IPSecurityAPI | getIpSecurityInfo | GET /security | Get threat intelligence for a single IP address TimeConversionAPI | convertTimeBetweenTimezones | GET /timezone/convert | Convert time from one timezone to another TimezoneAPI | getTimezoneInfo | GET /timezone | Get timezone information based on IP, coordinates, or name UserAgentAPI | getUserAgentDetails | GET /user-agent | Parse a single user-agent string UserAgentAPI | parseBulkUserAgentStrings | POST /user-agent-bulk | Parse multiple user-agent strings UserAgentAPI | parseUserAgentString | POST /user-agent | Alternate method to parse a single user-agent string

Example Usage

IP Geolocation Examples

This section shows how to use the getIpGeolocation() method from the TypeScript SDK across Free, Standard, and Advanced subscription tiers. Each example highlights different parameter combinations: fields, include, and excludes.

For the full list of supported fields/modules, refer to the IP Geolocation API Docs.

Developer (Free) Plan Examples

Default Fields

import {
  IPGeolocationApi,
  Configuration
} from 'ip-geolocation-api-sdk-typescript';

const configuration = new Configuration({ apiKey: 'YOUR_API_KEY' });
const api = new IPGeolocationApi(configuration);

const { data } = await api.getIpGeolocation({
    ip: '8.8.8.8'
});
console.log(data);

If you don't provide an IP address, the API will use the request origin (IP of the request) to return geolocation data.

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": "🇺🇸"
  },
  "country_metadata": {
    "calling_code": "+1",
    "tld": ".us",
    "languages": [
      "en-US",
      "es-US",
      "haw",
      "fr"
    ]
  },
  "currency": {
    "code": "USD",
    "name": "US Dollar",
    "symbol": "$"
  }
}z

Filtering Fields and Exclusions

import {
    IPGeolocationApi,
    Configuration
  } from 'ip-geolocation-api-sdk-typescript';
  
  const configuration = new Configuration({ apiKey: 'YOUR_API_KEY' });
  
  const api = new IPGeolocationApi(configuration);
  
  async function getLocation() {
    try {
      const { data } = await api.getIpGeolocation({
        ip: '8.8.4.4',
        fields: 'location',
        excludes: 'location.continent_code,location.continent_name'
      });
  
      console.log(data); 
    } catch (error) {
      console.error('Error fetching location:', error);
    }
}
  
getLocation();

Sample Response:

{
  "ip": "8.8.4.4",
  "location": {
    "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": "🇺🇸"
  }
}

Standard Plan Examples

Geolocation with Default Fields

import {
    IPGeolocationApi,
    Configuration
  } from 'ip-geolocation-api-sdk-typescript';
  
  const configuration = new Configuration({ apiKey: 'YOUR_API_KEY' });
  
  const api = new IPGeolocationApi(configuration);
  
  async function getLocation() {
    try {
      const { data } = await api.getIpGeolocation({
        ip: '8.8.4.4',
      });
  
      console.log(data); 
    } catch (error) {
      console.error('Error fetching location:', error);
    }
}
  
getLocation();

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": "🇺🇸"
  },
  "country_metadata": {
    "calling_code": "+1",
    "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": "$"
  }
}

Language Support Example

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

try {
      const { data } = await api.getIpGeolocation({
        ip: '2001:4230:4890::1',
        lang: 'fr'
      });
      console.log(data); 
} catch (error) {
      console.error('Error fetching data:', error);
}

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": "🇲🇺"
  },
  "country_metadata": {
    "calling_code": "+230",
    "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": "₨"
  }
}

Include Hostname, Timezone, and User-Agent

try {
  const { data } = await api.getIpGeolocation({
  ip: '4.5.6.7',
  fields: 'location.country_name,location.country_capital',
  include: 'user_agent,time_zone,hostnameFallbackLive'
});
  console.log(data); 
} catch (error) {
      console.error('Error fetching data:', error);
}

Sample Response:

{
  "ip": "4.5.6.7",
  "hostname": "4.5.6.7",
  "location": {
    "country_name": "United States",
    "country_capital": "Washington, D.C."
  },
  "time_zone": {
    "name": "America/Chicago",
    "offset": -6,
    "offset_with_dst": -5,
    "current_time": "2025-07-11 04:50:39.537-0500",
    "current_time_unix": 1752227439.537,
    "is_dst": true,
    "dst_savings": 1,
    "dst_exists": true,
    "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": "Ipgeolocation/2.0/typescript",
    "name": "Ipgeolocation",
    "type": "Special",
    "version": "2.0",
    "version_major": "2",
    "device": {
      "name": "Unknown",
      "type": "Unknown",
      "brand": "Unknown",
      "cpu": "Unknown"
    },
    "engine": {
      "name": "Unknown",
      "type": "Unknown",
      "version": "??",
      "version_major": "??"
    },
    "operating_system": {
      "name": "Unknown",
      "type": "Unknown",
      "version": "??",
      "version_major": "??",
      "build": "??"
    }
  }
}

Note on Hostname Parameters:
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

try {
  const { data } = await api.getIpGeolocation({
  ip: '8.8.8.8',
  excludes: 'location.country_flag,location.country_emoji',
  include: 'dma,abuse,security'
});
  console.log(data); 
} catch (error) {
      console.error('Error fetching data:', error);
}

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": "+1",
    "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": "984",
      "num_of_ipv6_routes": "104",
      "rir": "ARIN"
    },
    "connection_type": "",
    "company": {
      "name": "Google LLC",
      "type": "Business",
      "domain": "googlellc.com"
    }
  },
  "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": [
      "[email protected]"
    ],
    "phone_numbers": [
      "+1-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 supports bulk IP geolocation using getBulkIpGeolocation(). This is available for Standard and Advanced plans. All parameters like fields, include, and excludes can be used in bulk requests.

try {
    const {data} = await api.getBulkIpGeolocation({
    ips: ['8.8.8.8', '1.1.1.1']
    });
    console.log(data);
    } catch (error) {
    console.error('Error fetching location:', error);
}

IP Security Examples

The getIpSecurityInfo() method lets you query threat intelligence, proxy/VPN detection, and risk metadata for IPs.

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

Basic Request (Minimal Setup)

import {
    Configuration,
    IPSecurityApi
  } from 'ip-geolocation-api-sdk-typescript';
  

  const configuration = new Configuration({ apiKey: 'YOUR_API_KEY' });
  
  const api = new IPSecurityApi(configuration);
  
  async function getSecurity() {
    try {
      const {data} = await api.getIpSecurityInfo({
        ip: '2.56.188.34'
      });
      console.log(data);
    } catch (error) {
      console.error('Error fetching location:', error);
    }
  }
  
  getSecurity();

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

try {
    const {data} = await api.getIpSecurityInfo({
    ip: '2.56.188.34',
    include: 'location,network,currency,time_zone,user_agent,country_metadata,hostname'
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

Sample Response:

{
  "ip": "2.56.188.34",
  "hostname": "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."
  },
  "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": "Texas",
    "state_code": "US-TX",
    "district": "Dallas",
    "city": "Dallas",
    "zipcode": "75201",
    "latitude": "32.77822",
    "longitude": "-96.79512",
    "is_eu": false,
    "country_flag": "https://ipgeolocation.io/static/flags/us_64.png",
    "geoname_id": "4684902",
    "country_emoji": "🇺🇸"
  },
  "network": {
    "asn": {
      "as_number": "AS62240",
      "organization": "Clouvider Limited",
      "country": "GB"
    },
    "company": {
      "name": "Packethub S.A."
    }
  },
  "time_zone": {
    "name": "America/Chicago",
    "offset": -6,
    "offset_with_dst": -5,
    "current_time": "2025-07-16 11:00:50.605-0500",
    "current_time_unix": 1752681650.605,
    "is_dst": true,
    "dst_savings": 1,
    "dst_exists": true,
    "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": "Ipgeolocation/2.0/typescript",
    "name": "Ipgeolocation",
    "type": "Special",
    "version": "2.0",
    "version_major": "2",
    "device": {
      "name": "Unknown",
      "type": "Unknown",
      "brand": "Unknown",
      "cpu": "Unknown"
    },
    "engine": {
      "name": "Unknown",
      "type": "Unknown",
      "version": "??",
      "version_major": "??"
    },
    "operating_system": {
      "name": "Unknown",
      "type": "Unknown",
      "version": "??",
      "version_major": "??",
      "build": "??"
    }
  },
  "country_metadata": {
    "calling_code": "+1",
    "tld": ".us",
    "languages": [
      "en-US",
      "es-US",
      "haw",
      "fr"
    ]
  },
  "currency": {
    "code": "USD",
    "name": "US Dollar",
    "symbol": "$"
  }
}

Request with Field Filtering

try {
    const {data} = await api.getIpSecurityInfo({
    ip: '195.154.221.54',
    fields: 'security.is_tor,security.is_proxy,security.is_bot,security.is_spam'
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

Sample Response:

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

Bulk IP Security Lookup

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.

try {
    const {data} = await api.getBulkIpSecurityInfo({
    ips: ['2.56.188.34', '8.8.8.8'],
    fields: 'security.is_tor,security.is_proxy,security.is_bot,security.is_spam'
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

ASN API Examples

This section provides usage examples of the getAsnInfo() 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 subscription plans.

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

Get ASN Information by IP Address

import {
    Configuration,
    ASNLookupApi
  } from 'ip-geolocation-api-sdk-typescript';
  
  const configuration = new Configuration({ apiKey: 'YOUR_API_KEY' }); 
  const api = new ASNLookupApi(configuration);
  
  async function getASN() {
    try {
      const {data} = await api.getAsnInfo({
        ip: '8.8.8.8' // IP Address
      });
      console.log(data);
    } catch (error) {
      console.error('Error fetching location:', error);
    }
  }
  
getASN();

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": 983,
    "num_of_ipv6_routes": 104,
    "rir": "ARIN"
  }
}

Get ASN Information by ASN Number

try {
    const {data} = await api.getAsnInfo({
    asn: 15169 // ASN number
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

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": 983,
    "num_of_ipv6_routes": 104,
    "rir": "ARIN"
  }
}

Combine All objects using Include

try {
    const {data} = await api.getAsnInfo({
    asn: 12 // ASN number
    include: 'peers,downstreams,upstreams,routes,whois_response'
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

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",
      "128.122.0.0/16",
      "216.165.88.0/24",
      "192.86.139.0/24",
      "216.165.103.0/24",
      "216.165.89.0/24",
      "216.165.0.0/18",
      "216.165.112.0/21",
      "2607:f600::/32",
      "216.165.64.0/19",
      "216.165.102.0/24",
      "216.165.120.0/22"
    ],
    "upstreams": [
      {
        "as_number": "AS3269",
        "description": "Telecom Italia S.p.A.",
        "country": "IT"
      },
      {
        "as_number": "AS8220",
        "description": "COLT Technology Services Group Limited",
        "country": "GB"
      },
      {
        "as_number": "AS286",
        "description": "GTT Communications Inc.",
        "country": "US"
      },
      {
        "as_number": "AS3257",
        "description": "GTT Communications Inc.",
        "country": "US"
      },
      {
        "as_number": "AS3754",
        "description": "NYSERNet",
        "country": "US"
      },
      {
        "as_number": "AS3356",
        "description": "Level 3 Parent, LLC",
        "country": "US"
      },
      {
        "as_number": "AS6461",
        "description": "Zayo Bandwidth",
        "country": "US"
      },
      {
        "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": "AS8220",
        "description": "COLT Technology Services Group Limited",
        "country": "GB"
      },
      {
        "as_number": "AS394666",
        "description": "NYU Langone Health",
        "country": "US"
      },
      {
        "as_number": "AS286",
        "description": "GTT Communications Inc.",
        "country": "NL"
      },
      {
        "as_number": "AS286",
        "description": "GTT Communications Inc.",
        "country": "US"
      },
      {
        "as_number": "AS3257",
        "description": "GTT Communications Inc.",
        "country": "US"
      },
      {
        "as_number": "AS3754",
        "description": "NYSERNet",
        "country": "US"
      },
      {
        "as_number": "AS3356",
        "description": "Level 3 Parent, LLC",
        "country": "US"
      },
      {
        "as_number": "AS6461",
        "description": "Zayo Bandwidth",
        "country": "US"
      },
      {
        "as_number": "AS137",
        "description": "Consortium GARR",
        "country": "IT"
      },
      {
        "as_number": "AS54965",
        "description": "Polytechnic Institute of NYU",
        "country": "US"
      }
    ],
    "whois_response": "\n#\n# ARIN WHOIS data and services are subject to the Terms of Use\n# available at: https://www.arin.net/resources/registry/whois/tou/\n#\n# If you see inaccuracies in the results, please report at\n# https://www.arin.net/resources/registry/whois/inaccuracy_reporting/\n#\n# Copyright 1997-2025, American Registry for Internet Numbers, Ltd.\n#\n\n\nASNumber:       12\nASName:         NYU-DOMAIN\nASHandle:       AS12\nRegDate:        1984-07-05\nUpdated:        2023-05-25    \nRef:            https://rdap.arin.net/registry/autnum/12\n\n\nOrgName:        New York University\nOrgId:          NYU-Z\nAddress:        726 Broadway, 8th Floor - ITS\nCity:           New York\nStateProv:      NY\nPostalCode:     10003\nCountry:        US\nRegDate:        2023-05-15\nUpdated:        2023-05-15\nRef:            https://rdap.arin.net/registry/entity/NYU-Z\n\n\nOrgAbuseHandle: OIS9-ARIN\nOrgAbuseName:   Office of Information Security\nOrgAbusePhone:  +1-212-998-3333 \nOrgAbuseEmail:  [email protected]\nOrgAbuseRef:    https://rdap.arin.net/registry/entity/OIS9-ARIN\n\nOrgNOCHandle: COSI-ARIN\nOrgNOCName:   Communications Operations Services - ITS\nOrgNOCPhone:  +1-212-998-3444 \nOrgNOCEmail:  [email protected]\nOrgNOCRef:    https://rdap.arin.net/registry/entity/COSI-ARIN\n\nOrgTechHandle: COSI-ARIN\nOrgTechName:   Communications Operations Services - ITS\nOrgTechPhone:  +1-212-998-3444 \nOrgTechEmail:  [email protected]\nOrgTechRef:    https://rdap.arin.net/registry/entity/COSI-ARIN\n\nRNOCHandle: COSI-ARIN\nRNOCName:   Communications Operations Services - ITS\nRNOCPhone:  +1-212-998-3444 \nRNOCEmail:  [email protected]\nRNOCRef:    https://rdap.arin.net/registry/entity/COSI-ARIN\n\nRTechHandle: COSI-ARIN\nRTechName:   Communications Operations Services - ITS\nRTechPhone:  +1-212-998-3444 \nRTechEmail:  [email protected]\nRTechRef:    https://rdap.arin.net/registry/entity/COSI-ARIN\n\n\n#\n# ARIN WHOIS data and services are subject to the Terms of Use\n# available at: https://www.arin.net/resources/registry/whois/tou/\n#\n# If you see inaccuracies in the results, please report at\n# https://www.arin.net/resources/registry/whois/inaccuracy_reporting/\n#\n# Copyright 1997-2025, American Registry for Internet Numbers, Ltd.\n#\n"
  }
}

Timezone API Examples

This section provides usage examples of the getTimezoneInfo() method from the typescript SDK, showcasing how to fetch timezone and time-related data using different query types — IP address, latitude/longitude, timezone ID, IATA code, ICAO code, or UN/LOCODE.

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

Get Timezone by IP Address

import {
    Configuration,
    TimezoneApi
  } from 'ip-geolocation-api-sdk-typescript';

  const configuration = new Configuration({ apiKey: 'YOUR_API_KEY' });
  const api = new TimezoneApi(configuration);
  
  async function getTimezone() {
    try {
      const {data} = await api.getTimezoneInfo({
        ip: '8.8.8.8',
      });
      console.log(data);
    } catch (error) {
      console.error('Error fetching location:', error);
    }
  }
  
  getTimezone();

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",
    "zipcode": "94043-1351",
    "latitude": "37.42240",
    "longitude": "-122.08421"
  },
  "time_zone": {
    "name": "America/Los_Angeles",
    "offset": -8,
    "offset_with_dst": -7,
    "date": "2025-07-17T00:00:00.000Z",
    "date_time": "2025-07-17 04:14:57",
    "date_time_txt": "Thursday, July 17, 2025 04:14:57",
    "date_time_wti": "Thu, 17 Jul 2025 04:14:57 -0700",
    "date_time_ymd": "2025-07-17T11:14:57.000Z",
    "date_time_unix": 1752750897.094,
    "time_24": "04:14:57",
    "time_12": "04:14:57 AM",
    "week": 29,
    "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": "+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 09",
      "duration": "-1H",
      "gap": false,
      "date_time_after": "2025-11-02 TIME 01",
      "date_time_before": "2025-11-02 TIME 02",
      "overlap": true
    }
  }
}

Get Timezone by Timezone Name

try {
    const {data} = await api.getTimezoneInfo({
    tz: 'Europe/London',
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

Sample Response:

{
  "time_zone": {
    "name": "Europe/London",
    "offset": 0,
    "offset_with_dst": 1,
    "date": "2025-07-17T00:00:00.000Z",
    "date_time": "2025-07-17 12:17:33",
    "date_time_txt": "Thursday, July 17, 2025 12:17:33",
    "date_time_wti": "Thu, 17 Jul 2025 12:17:33 +0100",
    "date_time_ymd": "2025-07-17T11:17:33.000Z",
    "date_time_unix": 1752751053.019,
    "time_24": "12:17:33",
    "time_12": "12:17:33 PM",
    "week": 29,
    "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": "+1H",
      "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

try {
    const {data} = await api.getTimezoneInfo({
    location: 'Munich, Germany',
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

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-17T00:00:00.000Z",
    "date_time": "2025-07-17 13:19:49",
    "date_time_txt": "Thursday, July 17, 2025 13:19:49",
    "date_time_wti": "Thu, 17 Jul 2025 13:19:49 +0200",
    "date_time_ymd": "2025-07-17T11:19:49.000Z",
    "date_time_unix": 1752751189.372,
    "time_24": "13:19:49",
    "time_12": "01:19:49 PM",
    "week": 29,
    "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": "+1H",
      "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

try {
    const {data} = await api.getTimezoneInfo({
    lat: 48.8566,
    _long: 2.3522
});
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

Sample Response:

{
  "time_zone": {
    "name": "Europe/Paris",
    "offset": 1,
    "offset_with_dst": 2,
    "date": "2025-07-17T00:00:00.000Z",
    "date_time": "2025-07-17 13:31:58",
    "date_time_txt": "Thursday, July 17, 2025 13:31:58",
    "date_time_wti": "Thu, 17 Jul 2025 13:31:58 +0200",
    "date_time_ymd": "2025-07-17T11:31:58.000Z",
    "date_time_unix": 1752751918.965,
    "time_24": "13:31:58",
    "time_12": "01:31:58 PM",
    "week": 29,
    "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": "+1H",
      "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

try {
    const {data} = await api.getTimezoneInfo({
    iataDode: 'ZRH'
});
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

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-17T00:00:00.000Z",
    "date_time": "2025-07-17 13:43:56",
    "date_time_txt": "Thursday, July 17, 2025 13:43:56",
    "date_time_wti": "Thu, 17 Jul 2025 13:43:56 +0200",
    "date_time_ymd": "2025-07-17T11:43:56.000Z",
    "date_time_unix": 1752752636.652,
    "time_24": "13:43:56",
    "time_12": "01:43:56 PM",
    "week": 29,
    "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": "+1H",
      "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
    }
  }
}

You can also fetch Airport Details and Timezone using any ICAO code by passing the icaoCode parameter.

Get Timezone and City Details from UN/LOCODE

try {
    const {data} = await api.getTimezoneInfo({
    loCode: 'ESBCN'
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

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"
  },
  "time_zone": {
    "name": "Europe/Madrid",
    "offset": 1,
    "offset_with_dst": 2,
    "date": "2025-07-17T00:00:00.000Z",
    "date_time": "2025-07-17 14:59:43",
    "date_time_txt": "Thursday, July 17, 2025 14:59:43",
    "date_time_wti": "Thu, 17 Jul 2025 14:59:43 +0200",
    "date_time_ymd": "2025-07-17T12:59:43.000Z",
    "date_time_unix": 1752757183.827,
    "time_24": "14:59:43",
    "time_12": "02:59:43 PM",
    "week": 29,
    "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": "+1H",
      "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 API 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 the Timezone Converter API documentation.

Convert Current Time from One Timezone to Another

import {
    Configuration,
    TimeConversionApi
  } from 'ip-geolocation-api-sdk-typescript';

const configuration = new Configuration({ apiKey: 'YOUR_API_KEY' });
const api = new TimeConversionApi(configuration);

async function getTimezoneConversion() {
try {
    const {data} = await api.convertTimeBetweenTimezones({
    time: "2024-12-08 11:00",
    tzFrom: "America/New_York",
    tzTo: "Asia/Tokyo"
    });
    console.log(data);
} catch (error) {
    console.error('Error converting time:', error);
}
}

getTimezoneConversion();

Sample Response:

{
  original_time: 2024-12-08T06:00:00.000Z,
  converted_time: 2024-12-08T20:00:00.000Z,
  diff_hour: 14,
  diff_min: 840
}

You can convert time from any timezone to another using:

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

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

User Agent API Examples

This section provides usage examples of the getUserAgentDetails() and parseBulkUserAgentStrings() methods from the TypeScript 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.

Parse a Basic User Agent String

import {
    Configuration,
    UserAgentApi
  } from 'ip-geolocation-api-sdk-typescript';

  const configuration = new Configuration({ apiKey: 'YOUR_API_KEY' });
  
  const api = new UserAgentApi(configuration);
  
  async function getUserAgentDetails() {
    try {
      const {data} = await api.getUserAgentDetails({
       userAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
      });
      console.log(data);
    } catch (error) {
      console.error('Error fetching location:', error);
    }
  }
  
  getUserAgentDetails();

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": "??"
  }
}

Note: If you don’t pass any userAgent string, the API will return data of the device's current User-Agent automatically.

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.

Note: Bulk User Agent API is only available for paid plans

try {
    const {data} = await api.parseBulkUserAgentStrings({
    userAgents: [
        "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36",
        "Mozilla/5.0 (iPhone; CPU iPhone OS 16_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.0  Mobile/15E148 Safari/604.1"
    ]
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

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.

Astronomy by Coordinates

import {
    Configuration,
    AstronomyApi
  } from 'ip-geolocation-api-sdk-typescript';
  const configuration = new Configuration({ apiKey: 'YOUR_API_KEY' });
  
  const api = new AstronomyApi(configuration);
  
  async function getAstronomy() {
    try {
      const {data} = await api.getAstronomyDetails({
        lat: '40.7128',
        _long: '-74.0060'
      });
      console.log(data);
    } catch (error) {
      console.error('Error fetching location:', error);
    }
  }
  
getAstronomy();

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-22",
    "current_time": "12:08:03.637",
    "mid_night": "01:02",
    "night_end": "03:48",
    "morning": {
      "astronomical_twilight_begin": "03:48",
      "astronomical_twilight_end": "04:32",
      "nautical_twilight_begin": "04:32",
      "nautical_twilight_end": "05:12",
      "civil_twilight_begin": "05:12",
      "civil_twilight_end": "05:43",
      "blue_hour_begin": "04:59",
      "blue_hour_end": "05:24",
      "golden_hour_begin": "05:24",
      "golden_hour_end": "06:23"
    },
    "sunrise": "05:43",
    "sunset": "20:21",
    "evening": {
      "golden_hour_begin": "19:41",
      "golden_hour_end": "20:40",
      "blue_hour_begin": "20:40",
      "blue_hour_end": "21:05",
      "civil_twilight_begin": "20:21",
      "civil_twilight_end": "20:52",
      "nautical_twilight_begin": "20:52",
      "nautical_twilight_end": "21:31",
      "astronomical_twilight_begin": "21:31",
      "astronomical_twilight_end": "22:16"
    },
    "night_begin": "22:16",
    "sun_status": "-",
    "solar_noon": "13:02",
    "day_length": "14:37",
    "sun_altitude": 66.36171104779359,
    "sun_distance": 152012050.7566263,
    "sun_azimuth": 146.51841856976972,
    "moon_phase": "WANING_CRESCENT",
    "moonrise": "02:48",
    "moonset": "19:10",
    "moon_status": "-",
    "moon_altitude": 71.91067852938512,
    "moon_distance": 370332.8633592859,
    "moon_azimuth": 232.18896241301334,
    "moon_parallactic_angle": 42.90572861876801,
    "moon_illumination_percentage": "-5.82",
    "moon_angle": 332.0715969163789
  }
}

Astronomy by IP Address

try {
    const {data} = await api.getAstronomyDetails({
    ip: '8.8.8.8'
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

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-22",
    "current_time": "09:08:38.573",
    "mid_night": "01:15",
    "night_end": "04:18",
    "morning": {
      "astronomical_twilight_begin": "04:18",
      "astronomical_twilight_end": "04:58",
      "nautical_twilight_begin": "04:58",
      "nautical_twilight_end": "05:35",
      "civil_twilight_begin": "05:35",
      "civil_twilight_end": "06:04",
      "blue_hour_begin": "05:23",
      "blue_hour_end": "05:47",
      "golden_hour_begin": "05:47",
      "golden_hour_end": "06:42"
    },
    "sunrise": "06:04",
    "sunset": "20:24",
    "evening": {
      "golden_hour_begin": "19:46",
      "golden_hour_end": "20:42",
      "blue_hour_begin": "20:42",
      "blue_hour_end": "21:05",
      "civil_twilight_begin": "20:24",
      "civil_twilight_end": "20:54",
      "nautical_twilight_begin": "20:54",
      "nautical_twilight_end": "21:30",
      "astronomical_twilight_begin": "21:30",
      "astronomical_twilight_end": "22:10"
    },
    "night_begin": "22:10",
    "sun_status": "-",
    "solar_noon": "13:14",
    "day_length": "14:20",
    "sun_altitude": 34.34803129267899,
    "sun_distance": 152012050.75662628,
    "sun_azimuth": 89.8970525672089,
    "moon_phase": "WANING_CRESCENT",
    "moonrise": "03:23",
    "moonset": "19:16",
    "moon_status": "-",
    "moon_altitude": 62.034455712206615,
    "moon_distance": 370333.6185030786,
    "moon_azimuth": 99.42513011330385,
    "moon_parallactic_angle": -62.958244692944554,
    "moon_illumination_percentage": "-5.82",
    "moon_angle": 332.0769921001466
  }
}

Astronomy by Location String

try {
    const {data} = await api.getAstronomyDetails({
    location: 'Milan, Italy'
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

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-22",
    "current_time": "18:09:10.992",
    "mid_night": "01:29",
    "night_end": "03:39",
    "morning": {
      "astronomical_twilight_begin": "03:39",
      "astronomical_twilight_end": "04:35",
      "nautical_twilight_begin": "04:35",
      "nautical_twilight_end": "05:21",
      "civil_twilight_begin": "05:21",
      "civil_twilight_end": "05:54",
      "blue_hour_begin": "05:06",
      "blue_hour_end": "05:35",
      "golden_hour_begin": "05:35",
      "golden_hour_end": "06:40"
    },
    "sunrise": "05:54",
    "sunset": "21:04",
    "evening": {
      "golden_hour_begin": "20:19",
      "golden_hour_end": "21:24",
      "blue_hour_begin": "21:24",
      "blue_hour_end": "21:52",
      "civil_twilight_begin": "21:04",
      "civil_twilight_end": "21:38",
      "nautical_twilight_begin": "21:38",
      "nautical_twilight_end": "22:23",
      "astronomical_twilight_begin": "22:23",
      "astronomical_twilight_end": "23:18"
    },
    "night_begin": "23:18",
    "sun_status": "-",
    "solar_noon": "13:29",
    "day_length": "15:10",
    "sun_altitude": 28.169856679888845,
    "sun_distance": 152012050.75662634,
    "sun_azimuth": 270.6983052183797,
    "moon_phase": "WANING_CRESCENT",
    "moonrise": "02:36",
    "moonset": "19:49",
    "moon_status": "-",
    "moon_altitude": 13.689479853567155,
    "moon_distance": 370334.31938040146,
    "moon_azimuth": 296.84370445526883,
    "moon_parallactic_angle": 45.350334161659966,
    "moon_illumination_percentage": "-5.82",
    "moon_angle": 332.08199856245204
  }
}

Astronomy for Specific Date

const options = {
  lat: '-27.47',
  _long: '153.02',
  date: '2025-01-01'
};

try {
    const {data} = await api.getAstronomyDetails({
    lat: '-27.47',
    _long: '153.02',
    date: '2025-01-01'
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

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": "02:09:51.517",
    "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": -29.4286928132231,
    "sun_distance": 147102938.88036567,
    "sun_azimuth": 143.06960395892196,
    "moon_phase": "NEW_MOON",
    "moonrise": "05:42",
    "moonset": "20:08",
    "moon_status": "-",
    "moon_altitude": -31.0476016259822,
    "moon_distance": 383086.6727028855,
    "moon_azimuth": 154.73430237040986,
    "moon_parallactic_angle": -154.91634180109617,
    "moon_illumination_percentage": "0.62",
    "moon_angle": 9.03930980357242
  }
}

Astronomy in Different Language

You can also get Astronomy Data in other languages. This feature is only available for paid subscriptions.

try {
    const {data} = await api.getAstronomyDetails({
    ip: '1.1.1.1',
    lang: 'fr'
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

Sample Response:

{
  "ip": "1.1.1.1",
  "location": {
    "continent_code": "OC",
    "continent_name": "Océanie",
    "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-23",
    "current_time": "02:10:35.820",
    "mid_night": "23:54",
    "night_end": "05:12",
    "morning": {
      "astronomical_twilight_begin": "05:12",
      "astronomical_twilight_end": "05:40",
      "nautical_twilight_begin": "05:40",
      "nautical_twilight_end": "06:09",
      "civil_twilight_begin": "06:09",
      "civil_twilight_end": "06:34",
      "blue_hour_begin": "05:59",
      "blue_hour_end": "06:18",
      "golden_hour_begin": "06:18",
      "golden_hour_end": "07:08"
    },
    "sunrise": "06:34",
    "sunset": "17:15",
    "evening": {
      "golden_hour_begin": "16:41",
      "golden_hour_end": "17:30",
      "blue_hour_begin": "17:30",
      "blue_hour_end": "17:49",
      "civil_twilight_begin": "17:15",
      "civil_twilight_end": "17:39",
      "nautical_twilight_begin": "17:39",
      "nautical_twilight_end": "18:08",
      "astronomical_twilight_begin": "18:08",
      "astronomical_twilight_end": "18:36"
    },
    "night_begin": "18:36",
    "sun_status": "-",
    "solar_noon": "11:54",
    "day_length": "10:40",
    "sun_altitude": -58.11703247517492,
    "sun_distance": 152000449.99796307,
    "sun_azimuth": 95.84071235655404,
    "moon_phase": "WANING_CRESCENT",
    "moonrise": "05:08",
    "moonset": "15:24",
    "moon_status": "-",
    "moon_altitude": -34.311357641550224,
    "moon_distance": 370336.15393693856,
    "moon_azimuth": 72.88904329514799,
    "moon_parallactic_angle": -105.42137124967556,
    "moon_illumination_percentage": "-5.81",
    "moon_angle": 332.095098449164
  }
}

Abuse Contact API Examples

This section demonstrates how to use the getAbuseContactInfo() method of the SDK. 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.

Lookup Abuse Contact by IP

import {
    Configuration,
    AbuseContactApi
  } from 'ip-geolocation-api-sdk-typescript';
  const configuration = new Configuration({ apiKey: 'YOUR_API_KEY' });
  const api = new AbuseContactApi(configuration);

  async function getAbuseContact() {
    try {
      const {data} = await api.getAbuseContactInfo({
        ip: '1.0.0.0'
      });
      console.log(data);
    } catch (error) {
      console.error('Error fetching location:', error);
    }
  }
  
getAbuseContact();

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": [
      "[email protected]"
    ],
    "phone_numbers": [
      "+61 7 3858 3100"
    ]
  }
}

Lookup Abuse Contact with Specific Fields

try {
    const {data} = await api.getAbuseContactInfo({
    ip: '1.2.3.4',
    fields: 'abuse.role,abuse.emails'
    });
    console.log(data);
} catch (error) {
    console.error('Error fetching location:', error);
}

Sample Response:

{
  "ip": "1.2.3.4",
  "abuse": {
    "role": "abuse",
    "emails": [
      "[email protected]"
    ]
  }
}

Lookup Abuse Contact while Excluding Fields

try {
    const {data} = await api.getAbuseContactInfo({
    ip: '9.9.9.9',
    excludes: 'abuse.handle,abuse.emails'
    });
    console.log(data);
  } catch (error) {
    console.error('Error fetching location:', error);
}

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": [
      "+1-415-831-3129"
    ]
  }
}

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

IP Geolocation API Typescript SDK

Table of Contents

Installation

Using NPM

Using Yarn

Manual Installation

Authentication Setup

API Endpoints

Example Usage

IP Geolocation Examples

Developer (Free) Plan Examples

Default Fields

Filtering Fields and Exclusions

Standard Plan Examples

Geolocation with Default Fields

Language Support Example

Include Hostname, Timezone, and User-Agent

Advanced Plan Example

Include DMA, Abuse, and Security

Bulk IP Geolocation Example

IP Security Examples

Basic Request (Minimal Setup)

Include Multiple Optional Fields

Request with Field Filtering

Bulk IP Security Lookup

ASN API Examples

Get ASN Information by IP Address

Get ASN Information by ASN Number

Combine All objects using Include

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

Timezone Converter API Examples

Convert Current Time from One Timezone to Another

User Agent API Examples

Parse a Basic User Agent String

Bulk User Agent Parsing Example

Astronomy API Examples

Astronomy by Coordinates

Astronomy by IP Address

Astronomy by Location String

Astronomy for Specific Date

Astronomy in Different Language

Abuse Contact API Examples

Lookup Abuse Contact by IP

Lookup Abuse Contact with Specific Fields

Lookup Abuse Contact while Excluding Fields

Models