dus-ip-geolocation-node-client

DUS IP Geolocation Node Client

dus-ip-geolocation-node-client is a Node.js client for interacting with the D.U.S IP GeoLocator Server, a self-hosted solution for IP geolocation. The server uses WHOIS databases from sources like RIPE, APNIC, and others to provide accurate and reliable IP-based geolocation information.

Installation

You can install the package via npm:

npm install dus-ip-geolocation-node-client

Usage

Here are some examples of how to use the client to retrieve geolocation information for one or more IP addresses.

Basic Usage Example (JavaScript)

const DUSIpGeolocationNodeClient = require('dus-ip-geolocation-node-client');

(async () => {
    const client = new DUSIpGeolocationNodeClient("http://0.0.0.0:5000/");

    // Example 1: Get geolocation for a single IP
    const ip = "199.232.38.73";
    const result = await client.getGeolocationByIp(ip);
    console.log(result);

    // Example 2: Get geolocation for multiple IPs
    const ips2 = [
        "17.248.145.105",
        "216.58.209.42",
        "18.198.146.59",
        "2a03:2880:f203:c5:face:b00c:0:167"
    ];
    const result2 = await client.geolocateMultipleIps(ips2);
    console.log(result2);

})().catch((error) => {
    console.log(error);
    process.exit(1);
});

Basic Usage Example (TypeScript)

If you're using TypeScript, you can import and use the client as follows:

import DUSIpGeolocationNodeClient from 'dus-ip-geolocation-node-client';

(async () => {
    const client = new DUSIpGeolocationNodeClient("http://0.0.0.0:5000/");

    // Example 1: Get geolocation for a single IP
    const ip = "199.232.38.73";
    const result = await client.getGeolocationByIp(ip);
    console.log(result);

    // Example 2: Get geolocation for multiple IPs
    const ips2 = [
        "17.248.145.105",
        "216.58.209.42",
        "18.198.146.59",
        "2a03:2880:f203:c5:face:b00c:0:167"
    ];
    const result2 = await client.geolocateMultipleIps(ips2);
    console.log(result2);

})().catch((error) => {
    console.log(error);
    process.exit(1);
});

Example Responses

Response for getGeolocationByIp (Single IP)

{
    "asn_name": "FASTLY",
    "asn_number": 54113,
    "city_name": "Jacksonville",
    "country": "United States",
    "ip": "199.232.38.73",
    "ip_version": 4,
    "is_private": false,
    "iso_code": "US",
    "mnt_by": "Unknown",
    "netname": "SKYCA-3",
    "status": "valid",
    "db_version": "6.0.0"
}

Response for geolocateMultipleIps (Multiple IPs)

[
    {
        "asn_name": "APPLE-ENGINEERING",
        "asn_number": 714,
        "city_name": "Unknown",
        "country": "United States",
        "ip": "17.248.145.105",
        "ip_version": 4,
        "is_private": false,
        "iso_code": "US",
        "mnt_by": "Unknown",
        "netname": "APPLE-WWNET",
        "status": "valid",
        "db_version": "6.0.0"
    },
    {
        "asn_name": "GOOGLE",
        "asn_number": 15169,
        "city_name": "Unknown",
        "country": "United States",
        "ip": "216.58.209.42",
        "ip_version": 4,
        "is_private": false,
        "iso_code": "US",
        "mnt_by": "Unknown",
        "netname": "GOOGLE",
        "status": "valid",
        "db_version": "6.0.0"
    },
    {
        "asn_name": "AMAZON-02",
        "asn_number": 16509,
        "city_name": "Frankfurt am Main",
        "country": "Germany",
        "ip": "18.198.146.59",
        "ip_version": 4,
        "is_private": false,
        "iso_code": "DE",
        "mnt_by": "Unknown",
        "netname": "AMAZO-ZFRA",
        "status": "valid",
        "db_version": "6.0.0"
    },
    {
        "asn_name": "FACEBOOK",
        "asn_number": 32934,
        "city_name": "Unknown",
        "country": "United States",
        "ip": "2a03:2880:f203:c5:face:b00c:0:167",
        "ip_version": 6,
        "is_private": false,
        "iso_code": "US",
        "mnt_by": "RIPE-NCC-HM-MNT",
        "netname": "IE-FACEBOOK-201100822",
        "status": "valid",
        "db_version": "6.0.0"
    }
]

About the D.U.S IP GeoLocator Server

The D.U.S IP GeoLocator Server (short for "Di Unni Sii IP GeoLocator Server") is a simple, custom, and self-hosted solution for geolocating IP addresses. Built upon the openIPDb, it provides a reliable method for parsing and leveraging IP address data from RIPE, APNIC, and other databases.

This server offers a straightforward yet effective approach to IP geolocation, allowing users to query and obtain location-based information from IP addresses. Whether for analytical purposes, cybersecurity, or enhancing user experiences, the D.U.S IP GeoLocator Server offers a flexible and accessible solution tailored to your geolocation needs.

For more details about the server, including setup instructions and Docker images, visit the D.U.S IP GeoLocator Server repository.

Contributing

If you'd like to contribute to the project, feel free to open an issue or submit a pull request on GitHub.

License

This project is released under the MIT License. See the LICENSE file for more details.

Useful Links

• npm package
• Client Repository
• Server Repository