The public-ip npm package allows you to get your public IP address (IPv4 or IPv6) from different services. It supports both IPv4 and IPv6, and it can be used in Node.js environments.
Get IPv4 Address
This feature allows you to get your public IPv4 address. The code sample demonstrates how to use the public-ip package to fetch and log the IPv4 address.
const publicIp = require('public-ip');
(async () => {
console.log(await publicIp.v4());
})();Get IPv6 Address
This feature allows you to get your public IPv6 address. The code sample demonstrates how to use the public-ip package to fetch and log the IPv6 address.
const publicIp = require('public-ip');
(async () => {
console.log(await publicIp.v6());
})();Get IP Address with Options
This feature allows you to get your public IP address with additional options. The code sample demonstrates how to use the public-ip package to fetch the IPv4 address using only HTTPS services.
const publicIp = require('public-ip');
(async () => {
console.log(await publicIp.v4({ onlyHttps: true }));
})();The ipify package is another tool to get your public IP address. It is similar to public-ip but focuses on using the ipify service to fetch the IP address. It supports both IPv4 and IPv6.
The external-ip package provides a way to get your public IP address by querying multiple services and returning the first successful response. It offers more flexibility in terms of service selection compared to public-ip.
The public-ip-cli package is a command-line interface for the public-ip package. It allows you to fetch your public IP address directly from the command line, making it convenient for quick checks without writing code.
Get your public IP address - very fast!
In Node.js, it queries the DNS records of OpenDNS, Google DNS, and HTTPS services to determine your IP address. In browsers, it uses the excellent icanhaz and ipify services through HTTPS.
npm install public-ip
import {publicIp, publicIpv4, publicIpv6} from 'public-ip';
console.log(await publicIp()); // Falls back to IPv4
//=> 'fe80::200:f8ff:fe21:67cf'
console.log(await publicIpv6());
//=> 'fe80::200:f8ff:fe21:67cf'
console.log(await publicIpv4());
//=> '46.5.21.123'
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.
Returns a Promise<string> with your public IPv6 address. Rejects on error or timeout.
A .cancel() method is available on the promise, which can be used to cancel the request.
Returns a Promise<string> with your public IPv4 address. Rejects on error or timeout.
A .cancel() method is available on the promise, which can be used to cancel the request.
Type: object
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. The default behaviour is to check against DNS before using HTTPS fallback. If set to true, it will only check against HTTPS.
Type: string[]
Default: []
Add your own custom HTTPS endpoints to get the public IP from. They will only be used if everything else fails. Any service used as fallback must return the IP as a plain string.
import {publicIpv6} from 'public-ip';
await publicIpv6({
fallbackUrls: [
'https://ifconfig.co/ip'
]
});
Type: number
Default: 5000
The time in milliseconds until a request is considered timed out.
Error thrown when the public IP address could not be found.
Error thrown when the operation was canceled.
FAQs
Get your public IP address — very fast!
The npm package public-ip receives a total of 143,112 weekly downloads. As such, public-ip popularity was classified as popular.
We found that public-ip demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.