Socket
Socket
Sign inDemoInstall

@abstractapi/javascript-ip-geolocation

Package Overview
Dependencies
2
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@abstractapi/javascript-ip-geolocation

AbstractAPI Javascript IP Geolocation Library - Wrapper to quickly start using the powerful AbstractAPI's IP Geolocation service in your projects.


Version published
Maintainers
1
Weekly downloads
4
decreased by-60%

Weekly downloads

Readme

Source

AbstractAPI javascript-ip-geolocation library

Integrate the powerful IP Geolocation API from Abstract in your Javascript or NodeJS project in a few lines of code.

Abstract's IP Geolocation API is a fast, lightweight, modern, and RESTful JSON API allowing you to look up the location, timezone, country details, and more of an IPv4 or IPv6 address.

It's very simple to use: you only need to submit your API key and an IP address, and the API will respond with an assessment of its geographical location, as well as additional details like the timezone, if it's a VPN address, and more.

Validating and verifying IP addresses is a critical step to reducing the chances of low-quality data and fraudulent or risky users in your website or application.

Documentation

Installation

You can install javascript-ip-geolocation via npm, from our CDN, or download the source into your project.

ES6

Download and install the library from npm:

npm install @abstractapi/javascript-ip-geolocation --save

In your project, import it and configure your API_KEY:

import {AbstractIpGeolocation} from 'javascript-ip-geolocation'

AbstractIpGeolocation.configure('API_KEY')

Browser, from the CDN

You can have the browser download the library from its closest location through jsDeliver CDN:

<script src="https://cdn.jsdelivr.net/npm/@abstractapi/javascript-core@latest/dist/javascript-core.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@abstractapi/javascript-ip-geolocation@latest/dist/javascript-ip-geolocation.js"></script>
<script>
    AbstractEmailValidation.configure('API_KEY');

    // use the library
</script>

Browser, from the built file

You can build the library yourself, or get the already built file from the dist directory and load it:

<script src="dist/javascript-ip-geolocation.js"></script>
<script>
    AbstractIpGeolocation.configure('API_KEY');

    // use the library
</script>

API key

Get your API key for free and without hassle from the Abstact website.

Quickstart

AbstractAPI javascript-ip-geolocation library returns a Promise so you can use one of the following approaches:

Async/Await

async function validateIP(ipAddress) {
  let response = await AbstractIpGeolocation.look_up(ipAddress);
  console.log(response);
}

Using .then()

function validateIP(ipAddress) {
  AbstractIpGeolocation.look_up(ipAddress)
    .then(response => {
        console.log(response);
    })
}

API response

The API response contains the following fields:

PARAMETERTYPEDETAILS
ParameterTypeDetails
ip_addressStringThe requested IP address
cityStringCity's name.
city_geoname_idStringCity's geoname ID.
regionStringState or province in which the the city is located.
region_iso_codeChar[2]State or province's ISO 3166-2 code.
region_geoname_idStringState or province's geoname ID.
postal_codeStringZIP or postal code.
countryStringCountry's name.
country_codeChar[2]Country's ISO 3166-1 alpha-2 code.
country_geoname_idStringCountry's geoname ID.
country_is_euBooleanTrue if the country is in the EU, false if it is not.
continentStringContinent's name.
continent_codeChar[2]2 letter continent code: AF, AS, EU, NA, OC, SA, AN
continent_geoname_idStringContinent's geoname ID.
longitudeFloatDecimal of the longitude.
latitudeFloatDecimal of the latitude.
security > is_vpnBooleanWhether the IP address is using from a VPN or using a proxy
timezone > nameStringTimezone's name from the IANA Time Zone Database.
timezone > abbreviationStringTimezone's abbreviation, also from the IANA Time Zone Database.
timezone > gmt_offsetStringTimezone's offset from Greenwich Mean Time (GMT).
timezone > current_timeStringCurrent time in the local time zone.
timezone > is_dstBooleanTrue if the location is currently in Daylight Savings Time (DST).
flag > svgStringLink to a hosted version of the country's flag in SVG format.
flag > pngStringLink to a hosted version of the country's flag in PNG format.
flag > emojiStringCountry's flag as an emoji.
flag > unicodeStringCountry's flag in unicode.
currency > currency_nameStringThe currency's name.
currency > currency_codeStringThe currency's code in ISO 4217 format.
connection > connection_typeStringType of network connection: Dialup, Cable/DSL, Cellular, Corporate
connection > autonomous_system_numberUint32Autonomous System number
connection > autonomous_system_organizationStringAutonomous System Organization name.
connection > isp_nameStringInternet Service Provider (ISP) name.
connection > organization_nameStringOrganization name.

Detailed documentation

You will find additional information and request examples in the Abstract help page.

Getting help

If you need help installing or using the library, please contact Abstract's Support.

For bug report and feature suggestion, please use this repository issues page.

Contribution

Contributions are always welcome, as they improve the quality of the libraries we provide to the community.

Please provide your changes covered by the appropriate unit tests, and post them in the pull requests page.

NPM

Installation

Run npm install in the command line to install the dependencies. To update those dependencies you need to run npm update.

Building

To build the library and generate the minified file in the dist directory, you need to run npm run build.

To build the lib, you need to run npm run build:lib.

Test

To run the test suite, you need to run: npm run test.

Keywords

FAQs

Last updated on 28 May 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc