Popularity
4.4
Growing
Activity
4.7
Growing
433
19
32

Monthly Downloads: 0
Programming language: JavaScript
License: MIT License
Tags: Command Line Apps     Fast     External     Public     Address     Ipv6     Ipv4     Ip     Get     Machine     Dns     Opendns    
Latest version: v3.2.0

public-ip alternatives and similar modules

Based on the "Command Line Apps" category

Do you think we are missing an alternative of public-ip or a related project?

Add another 'Command Line Apps' Module

README

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