Skip to content

Latest commit

 

History

History
159 lines (110 loc) · 5.39 KB

README.md

File metadata and controls

159 lines (110 loc) · 5.39 KB
Raw

IPinfo IPinfo Node.js Express Client Library

This is the official Node.js Express client library for the IPinfo.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 address here.

Getting Started

You'll need an IPinfo API access token, which you can get by signing up for a free account at https://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 see https://ipinfo.io/pricing

Installation

npm

npm install ipinfo-express

yarn

yarn add ipinfo-express

Usage

The following is the interface of the middleware function.

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

The cache key is the same as that described in https://github.com/ipinfo/node#caching.

The timeout key is the same as that described in https://github.com/ipinfo/node#timeouts.

The ipSelector is the function that returns the selected IP.

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

Full Example

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

const express = require('express')
const ipinfo = require('ipinfo-express')

const app = 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`)
})

IP Selection Mechanism

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.

Using built-in IP selectors

  • Default IP Selector
  • Originating IP Selector
Default IP selector

A defaultIPSelector 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 the ipSelector while setting the middleware function.

const ipinfo = require('ipinfo-express')
const { defaultIPSelector } = require('ipinfo-express')

const app = express()
app.use(ipinfo({
    token: "token",
    cache: null,
    timeout: 5000,
    ipSelector: defaultIPSelector
}))
Originating IP selector

A originatingIPSelector selects an IP address by trying to extract it from the X-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 the ipSelector while setting the middleware function.

const ipinfo = require('ipinfo-express')
const { originatingIPSelector } = require('ipinfo-express')

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

Using a custom IP selector

In case a custom IP selector is required, you may set your custom function to ipSelector. Your custom function should take req as an argument and return an IP in string format.

For example:

const ipinfo = require('ipinfo-express')

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

Other Libraries

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.

About IPinfo

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.

image