ip-country

IP Country

The fastest way to detect country code based on the IP address using minimal amount of memory.

Installation

Using npm:

$ npm install ip-country --save

Using yarn:

$ yarn add ip-country

Usage

Standalone:

// Load the module.
const ipCountry = require('ip-country')

// Initiate the module with custom options.
ipCountry.init({
  // You can specify the path to a custom MMDb file if you want
  // more details about IP addresses (like, city, zipcode, population).
  // Note: For most cases the default MMDb file should be enough.
  // Note: You can find free Dbs here: http://dev.maxmind.com/geoip/geoip2/geolite2/
  // Note: Big MMDb files will use more memory and lookups will be slower.
  mmdb: 'BUILTIN_MMDB_PATH',

  // Return a default country when the country can not be detected from the IP.
  fallbackCountry: 'US',

  // Expose full IP lookup info in the request (`res.locals.IPInfo`).
  exposeInfo: false
})

// Get information about an IP.
ipCountry.lookup('72.229.28.185') // Object
ipCountry.lookup('87.242.77.197') // Object
ipCountry.lookup('foobar') // null
ipCountry.lookup() // null

// Detect country code of an IP.
ipCountry.country('72.229.28.185') // US
ipCountry.country('87.242.77.197') // RU
ipCountry.country('foobar') // US (fallback country)
ipCountry.country() // US (fallback country)

In ExpressJS:

// Load the module.
const ipCountry = require('ip-country')

// The Express app.
const app = express()

// The `ip-country` module will automatically use `res.locals.ip`
// when it is available, or the `req.ip` otherwise.
app.use((req, res, next) => {
  res.locals.ip = '87.242.77.197' // Russian IP address.
  next()
})

// Use the middleware to expose IP info and detected country code to the request.
app.use(ipCountry.setup({
  /* accepts same options as the standalone init method */
}))

// Now, you can use exposed details.
app.get('/', (req, res) => {

  // You should be able to access the country of client.
  res.locals.country // RU (detected using IP from `res.locals.ip`)

  // If you used `exposeInfo: true` option you should be able to access
  // the entire lookup info.
  res.locals.IPInfo // Is an `Object` when `exposeInfo` is `true` and `undefined` otherwise.

  res.send('EOF')
})

License

The MIT License (MIT)

Copyright (c) 2017 Ion Suman [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.