ipinfo
An http://ipinfo.io NodeJS wrapper.
:cloud: Installation
# Using npm
npm install --save ipinfo
# Using yarn
yarn add ipinfo
:clipboard: Example
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:
-
Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
-
For bug reports and feature requests, open issues. :bug:
-
For direct and quick help, you can use Codementor. :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.
: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:
-
—I love books! I will remember you after years if you buy me one. :grin: :book:
-
—You can make one-time donations via PayPal. I'll probably buy a coffeetea. :tea: -
—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
Thanks! :heart:
:dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
auto-geo-sunset(by Amin El-Naggar)—Automagically figures out your location using your ip, and uses that to calculate the time of sunset.cli-sunset—A fancy command line tool for knowing the sunset time.family_one—https://medium.com/@pshrmn/a-simple-react-router-v4-tutorial-7f23ff27adfhapi-geo-locate(by Future Studio)—Provide IP geo location for incoming requests in hapiionicabizau.net—My blogipinfo-cli(by Chintan Radia)—Get current ip informationmachine-ip—Update your public ip information in a git repository.sphere-ipinfo-mashup(by Martin Möllmann)—Create carts in SPHERE.IO with information based on your IP address.sunset-year—Sunset times during the year, every week.