Package detail

@iplookup/country-extra

sapics3.6kMIT1.0.20250624

Browser api to lookup country from IP address

location, iplookup, lookup, geo

readme

@iplookup/country-extra npm version

This is an API created to make ip-location-api available for browsers. The database itself is large at 7MB, so it is splitted into over 2000 pieces for fast downloading in a browser.

Synopsis

<script src="https://cdn.jsdelivr.net/npm/@iplookup/country-extra/iplookup.min.js"></script>
<script type="text/javascript">
async function run(){
    var ip = "207.97.227.239"
    var location = await IpLookup(ip)
    console.log(location)
    // {
    //   country: 'FR',
    //   country_name: 'France',
    //   country_native: 'France',
    //   phone: [ 33 ],
    //   continent: 'EU',
    //   capital: 'Paris',
    //   currency: [ 'EUR' ],
    //   languages: [ 'fr' ],
    //   continent_name: 'Europe'
    // }
}
</script>

ESM

import IpLookup from '@iplookup/country-extra'
await IpLookup("2402:b801:ea8b:23c0::")

CJS

const IpLookup = require('@iplookup/country-extra')
await IpLookup("207.97.227.239")

If you do not need extra information about country, try to use @iplookup/country.

License

Since each user download a partial database, we use the CC0 Licensed database geo-whois-asn-country for ip to country mapping to avoid license problem.

To get extra information about country, we use Countries which is published under MIT license by Annexare Studio.

The software itself is published under MIT license by sapics.

changelog

Changelog

3.0.2

After this version, the database directory which includes postcode is changed. The database is automatically updated when changing from v2 to v3.

3.0.0 Remake postcode database

If you use postcode field, you need to update database after updating to v3. (As above, it will automatically updates after v3.0.2)

Previous v2 has troubles as #21 with some postcodes. To fix them, we remake database structure for postcode.

2.0.0 Auto-update and create database at initial run.

Automatic updates and creation of databases at initial runtime have been added by default. While many users will not need to make any changes, this is a major update as it may have made a difference in usage for some.

  • Add new CLI parameter ILA_AUTO_UPDATE which updates database twice weekly with default setting and you can set cron format.
  • Create database at initial run.