Repository files navigation

This is the official Node.js Express client library for theIPinfo.io IP address API, allowing you to look up your own IP address, or get any of the following details for an IP:

• IP to geolocation (city, region, country, postal code, latitude, and longitude)
• IP to ASN (ISP or network operator, associated domain name, and type, such as business, hosting, or company)
• IP to Company (the name and domain of the business that uses the IP address)
• IP to Carrier (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)

Check all the data we have for your IP addresshere.

You'll need an IPinfo API access token, which you can get by signing up for a free account athttps://ipinfo.io/signup.

The free plan is limited to 50,000 requests per month, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes seehttps://ipinfo.io/pricing

The library also supports the Lite API, see theLite API section for more info.

npm install ipinfo-express

yarn add ipinfo-express

The following is the interface of the middleware function.

Thetoken is the string token you get when registered with IPinfo.

Thecache key is the same as that described inhttps://github.com/ipinfo/node#caching.

Thetimeout key is the same as that described inhttps://github.com/ipinfo/node#timeouts.

TheipSelector is the function that returns the selected IP.

ipinfo({token:"<token>",cache:<cache_class>,    timeout: 5000,    ipSelector: null});

The following is a full example of using the middleware function.

constexpress=require('express')constipinfo=require('ipinfo-express')constapp=express()app.use(ipinfo({token:"token",cache:null,timeout:5000,ipSelector:null}))app.get('/',function(req,res){res.send(req.ipinfo)})app.listen(3000,()=>{console.log(`Server is running`)})

By default, the IP from the incoming request object is used.

Since the desired IP by your system may be in other locations, the IP selection mechanism is configurable and some alternative built-in options are available.

• Default IP Selector
• Originating IP Selector

AdefaultIPSelector function is used by default if no IP selection method is provided. It returns the default IP from the incoming request object of Express.

This selector can be set explicitly by setting theipSelector while setting the middleware function.

constipinfo=require('ipinfo-express')const{ defaultIPSelector}=require('ipinfo-express')constapp=express()app.use(ipinfo({token:"token",cache:null,timeout:5000,ipSelector:defaultIPSelector}))

AoriginatingIPSelector selects an IP address by trying to extract it from theX-Forwarded-For header. This is not always the most reliable unless your proxy setup allows you to trust it. It will default to the source IP on the request if the header doesn't exist.

This selector can be set by setting theipSelector while setting the middleware function.

constipinfo=require('ipinfo-express')const{ originatingIPSelector}=require('ipinfo-express')constapp=express()app.use(ipinfo({token:"token",cache:null,timeout:5000,ipSelector:originatingIPSelector}))

In case a custom IP selector is required, you may set your custom function toipSelector. Your custom function should takereq as an argument and return an IP instring format.

For example:

constipinfo=require('ipinfo-express')constapp=express()app.use(ipinfo({token:"token",cache:null,timeout:5000,ipSelector:(req)=>{ip=""// update ip according to your logic and return the selected IPreturnip}}))

The library gives the possibility to use theLite API too, authentication with your token is still required.

The IP details returned are slightly different from the Core API middleware, though the arguments are identical.

const{ ipinfoLite}=require('ipinfo-express')ipinfoLite({token:"<token>",cache:<cache_class>,timeout:5000,ipSelector:null});

There are official IPinfo client libraries available for many languages including PHP, Go, Java, Ruby, and many popular frameworks such as Django, Rails, and Laravel. There are also many third-party libraries and integrations available for our API.

Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier, VPN detection, hosted domains, and IP type data sets. Our API handles over 20 billion requests a month for 100,000 businesses and developers.