<commit_before><!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


# ipinfo

 [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/ipinfo.svg)](https://www.npmjs.com/package/ipinfo) [![Downloads](https://img.shields.io/npm/dt/ipinfo.svg)](https://www.npmjs.com/package/ipinfo) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>

> An http://ipinfo.io NodeJS wrapper.

## :cloud: Installation

```sh
# Using npm
npm install --save ipinfo

# Using yarn
yarn add ipinfo
```


## :clipboard: Example



```js
const ipInfo = require("ipinfo");

// Current ip information
ipInfo((err, cLoc) => {
    console.log(err || cLoc);
    // { ip: '94. ... .77',
    //   hostname: '... .com',
    //   city: '...',
    //   region: 'England',
    //   country: 'GB',
    //   loc: '5...,3...',
    //   org: '... UK Limited',
    //   postal: '...' }

    // Get information about a known ip
    ipInfo("8.8.8.8", (err, cLoc) => {
        console.log(err || cLoc);
        // { ip: '8.8.8.8',
        //   hostname: 'google-public-dns-a.google.com',
        //   city: 'Mountain View',
        //   region: 'California',
        //   country: 'US',
        //   loc: '37.3845,-122.0881',
        //   org: 'AS15169 Google Inc.',
        //   postal: '94040' }

        // Get organization
        ipInfo("8.8.8.8/org", (err, cLoc) => {
            console.log(err || cLoc);
            // AS15169 Google Inc.
        });
    });
});
```



## :question: Get Help

There are few ways to get help:

 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
 2. For bug reports and feature requests, open issues. :bug:

 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:



## :memo: Documentation


### `ipInfo(type, token, callback)`
Makes requests to the ipinfo.io resources.

#### Params

- **String** `type`: An optional string parameter that can be:
 - An ip (e.g. `"8.8.8.8"`)
 - An ip and the a field (e.g. `"8.8.8.8/org"`)
- **String** `token`: The token used if you have to make an authorized request.
- **Function** `callback`: The callback function.



## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].


## :sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:


 - Starring and sharing the projects you like :rocket:
 - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
 - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
 - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
 - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`<commit_msg>Clean up readme<commit_after><!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


# ipinfo

 [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/ipinfo.svg)](https://www.npmjs.com/package/ipinfo) [![Downloads](https://img.shields.io/npm/dt/ipinfo.svg)](https://www.npmjs.com/package/ipinfo) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>

> An http://ipinfo.io NodeJS wrapper.

## :cloud: Installation

```sh
# Using npm
npm install --save ipinfo

# Using yarn
yarn add ipinfo
```


## :clipboard: Example


### Basic usage
```js
const ipInfo = require("ipinfo");

ipInfo(IP_ADDRESS, AUTH_TOKEN, CALLBACK(err, cLoc) => {
    console.log(err || cLoc);
    // { ip: '94. ... .77',
    //   hostname: '... .com',
    //   city: '...',
    //   region: 'England',
    //   country: 'GB',
    //   loc: '5...,3...',
    //   org: '... UK Limited',
    //   postal: '...' }
});
```

### Get current host machine IP address information
```js
ipInfo((err, cLoc) => {
    console.log(err || cLoc);
    // { ip: '94. ... .77',
    //   hostname: '... .com',
    //   city: '...',
    //   region: 'England',
    //   country: 'GB',
    //   loc: '5...,3...',
    //   org: '... UK Limited',
    //   postal: '...' }
});
```

### Get information about a known IP
```js
ipInfo("8.8.8.8", (err, cLoc) => {
    console.log(err || cLoc);
    // { ip: '8.8.8.8',
    //   hostname: 'google-public-dns-a.google.com',
    //   city: 'Mountain View',
    //   region: 'California',
    //   country: 'US',
    //   loc: '37.3845,-122.0881',
    //   org: 'AS15169 Google Inc.',
    //   postal: '94040' }

});
```

### Get IP info for specific field
```js
ipInfo("8.8.8.8/org", (err, cLoc) => {
    console.log(err || cLoc);
    // AS15169 Google Inc.
});
```



## :question: Get Help

There are few ways to get help:

 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
 2. For bug reports and feature requests, open issues. :bug:

 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:



## :memo: Documentation


### `ipInfo(type, token, callback)`
Makes requests to the ipinfo.io resources.

#### Params

- **String** `type`: An optional string parameter that can be:
  - An ip (e.g. `"8.8.8.8"`)
  - An ip and the a field (e.g. `"8.8.8.8/org"`)
- **String** `token`: The token used if you have to make an authorized request.
- **Function** `callback`: The callback function.



## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].


## :sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:


 - Starring and sharing the projects you like :rocket:
 - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
 - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
 - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
 - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
{'fraction_non_alphanumeric': 0.16662687992360944, 'fraction_numerical': 0.017187873000716163, 'mean_word_length': 3.285933503836317, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 20, 'https://': 24, 'lorem ipsum': 0, 'www.': 12, 'xml': 0}, 'pii_count': 10, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4750975', 'n_tokens_mistral': 3016, 'n_tokens_neox': 2801, 'n_words': 860}