Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.22 KB

README.md

File metadata and controls

59 lines (36 loc) · 1.22 KB
Raw

iplocation Travis CI Build Status

Get ip location information.

NPM Badge

Install

npm install iplocation

Usage

const ipLocation = require("iplocation");

(async () => {
	await ipLocation("172.217.167.78");
	//=> { latitude: -33.8591, longitude: 151.2002, region: { name: "New South Wales" ... } ... }
})();

API

ipLocation(ip, options?)

ip

Type: string

The ipv4 address to get the information for.

options

Type: object

apiKey

Type: string

An optional ipapi API key to use.

const ipLocation = require("iplocation");

(async () => {
	await ipLocation("172.217.167.78", { apiKey: 'YOUR_API_KEY' });
	//=> { latitude: -33.8591, longitude: 151.2002, region: { name: "New South Wales" ... } ... }
})();

Providers

iplocation currently uses ipapi for IP lookups. Their free API is limited to 1000 requests per day.

Related