npm

Need private packages and team management tools?Check out npm Orgs. »

public-ip

3.2.0 • Public • Published

public-ip Build Status

Get your public IP address - very fast!

In Node.js, it queries the DNS records of OpenDNS which has an entry with your IP address. In browsers, it uses the excellent icanhaz service through HTTPS.

Install

$ npm install public-ip

Usage

const publicIp = require('public-ip');
 
(async () => {
    console.log(await publicIp.v4());
    //=> '46.5.21.123'
 
    console.log(await publicIp.v6());
    //=> 'fe80::200:f8ff:fe21:67cf'
})();

API

publicIp.v4(options?)

publicIp.v6(options?)

Returns a Promise<string> with your public IPv4 or IPv6 address. Rejects on error or timeout. A .cancel() method is available on the promise, which can be used to cancel the request.

options

Type: object

https

Type: boolean
Default: false

Use a HTTPS check using the icanhazip.com service instead of the DNS query. ipify.org is used as a fallback if icanhazip.com fails. This check is much more secure and tamper-proof, but also a lot slower. This option is only available in the Node.js version.

timeout

Type: number
Default: 5000

The time in milliseconds until a request is considered timed out.

Maintainers

Related

install

npm i public-ip

Downloadsweekly downloads

60,594

version

3.2.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability