sindresorhus / Ipify
Licence: mit
Get your public IP address
Stars: ✭ 196
Programming Languages
javascript
184084 projects - #8 most used programming language
ipify
Get your public IP address
Using the Ipify API or a custom Ipify instance.
Install
$ npm install ipify
Usage
const ipify = require('ipify');
(async () => {
console.log(await ipify());
//=> '2001:0db8:85a3:0000:0000:8a2e:0370:7334'
console.log(await ipify({useIPv6: false}));
//=> '82.142.31.236'
})();
API
ipify(options?)
Returns a Promise<string>
with an IP address.
options
Type: object
useIPv6
Type: boolean
Default: true
Use the IPv6 API endpoint. The IPv6 endpoint will return an IPv6 address if available, IPv4 address otherwise.
Setting the endpoint
option will override this.
endpoint
Type: string
Default: 'https://api6.ipify.org'
Custom API endpoint.
FAQ
public-ip
?
How is this different from This package only targets the Ipify service, while public-ip
targets multiple services, is faster, and more resilient. Unless you run your own Ipify instance, you probably want public-ip
instead.
Related
- ipify-cli - CLI for this module
- internal-ip - Get your internal IPv4 or IPv6 address
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].