README.md

🗺️ GeoIP Lite 2: API Wrapper

📝 Information

This documentation provides information about the lightweight Node.js module designed for sending requests to a geolocation data API. This module enables you to retrieve location information for a specified IP address and takes full advantage of native modules. The official API is thoroughly optimized ⚡ and secure 🔐.

We use the MaxMind database in the geoip-lite2 module for our API. Due to certain limitations, the database is not updated daily (and never will be) by the module's developer. Updates are issued periodically.

💻 Locally

There is an alternative to this module that allows for local geolocation retrieval based on a specific IP address. However, this will increase the memory usage because the alternative module stores the MaxMind database in RAM.

geoip-lite2 on npm

📥 Installation

npm install geoip2-api

😎 Example

const geoIp = require('geoip2-api');

(async () => {
    const data = await geoIp.get('185.244.214.231');
    console.log(data);
});

Open example.js >>

✨ Output

GET https://api.sefinek.net/api/v2/geoip/185.244.214.231

{
  "success": true,
  "status": 200,
  "validationErr": false,
  "ip": "185.244.214.231",
  "data": {
    "range": [3119830528, 3119830783],
    "country": "PL",
    "region": "14",
    "eu": "1",
    "timezone": "Europe/Warsaw",
    "city": "Warsaw",
    "ll": [52.1574, 21.0126],
    "metro": 0,
    "area": 20
  }
}

🌠 API Tip

If you want to get the client's geolocation, instead of providing an IP, use /api/v2/geoip/myip.

💙 Support

For any questions or issues related to the script, please visit the GitHub repository for the latest updates and support.

If you like this module, please star ⭐ the repository.

🔑 MIT License

This GeoIP API client script is provided under the MIT License. See the LICENSE file for more details.

Copyright 2023-2024 © by Sefinek. All Rights Reserved.