Socket
Socket
Sign inDemoInstall

@yegor_heiz/ip-api

Package Overview
Dependencies
5
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @yegor_heiz/ip-api

API wrapper for ip-api. Fast, accurate, reliable. Free for non-commercial use, no API key required. Serving more than 1 billion requests per day, trusted by thousands of businesses


Version published
Weekly downloads
3
increased by50%
Maintainers
1
Install size
373 kB
Created
Weekly downloads
 

Readme

Source

IP API Docs

Fast, accurate, reliable. Free for non-commercial use, no API key required. Serving more than 1 billion requests per day, trusted by thousands of businesses

Example

const IPApi = require('IPApi');

// Can be an IP address or a domain
const ip = '24.48.0.1';

const start = async () => {
    // Fetch 'country' and 'countryCode' fields from 24.48.0.1 on russian language
    return await IPApi.get(ip, ['country', 'countryCode'], 'ru');
    // Or you can do sth like this 
    // return await IPApi.get('google.com');
};

start()
    .then(result => {
        // Log result 
        console.log(result.data);
    })
    .catch(e => {
        console.log(e);
    });

IPApi

Wrapper for ip-api

Kind: global class

IPApi.get(ip, fields, lang) ⇒ Promise.<*>

Fetch data about ip address or domain

Kind: static method of IPApi

ParamTypeDefaultDescription
ipstringCan be ip address or domain
fieldsArray.<string>If you don't require all the returned fields you can specify which data should be returned
langstring"en"Localized city, regionName and country. Can be: en - English (default) de - Deutsch (German) es - Español (Spanish) pt-BR - Español - Argentina (Spanish) fr - Français (French) ja - 日本語 (Japanese) zh-CN - 中国 (Chinese) ru - Русский (Russian)

Example

get('google.com');
get('google.com', ['country', 'countryCode']);
get('google.com', ['country', 'countryCode'], 'de');

Keywords

FAQs

Last updated on 11 Mar 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc