IPFinder Node.js Client Library
The official Node.js client library for the IPFinder.io get details for :
- IP address details (city, region, country, postal code, latitude and more ..)
- ASN details (Organization name, registry,domain,comany_type, and more .. )
- Firewall by supported formats details (apache_allow, nginx_deny, CIDR , and more ..)
- IP Address Ranges by the Organization name details (list_asn, list_prefixes , and more ..)
- service status details (queriesPerDay, queriesLeft, key_type, key_info)
- Get Domain IP (asn, organization,country_code ....)
- Get Domain IP history (total_ip, list_ip,organization,asn ....)
- Get list Domain By ASN, Country,Ranges (select_by , total_domain , list_domain ....)
Getting Started
singup for a free account at https://ipfinder.io/auth/signup, for Free IPFinder API access token.
The free plan is limited to 4,000 requests a day, and doesn't include some of the data fields To enable all the data fields and additional request volumes see https://ipfinder.io/pricing.
Documentation
See the official documentation.
Installation
Installing using npm or yarn:
npm install ipfinder
# or
yarn add ipfinder
free
TOKEN
With const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder(); // emty token == free
// lookup your IP address information
ipfinder.Authentication().then(data => {
console.log(data);
// console.log(data.status_message);
}).catch(console.log);
Authentication
const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder('YOUR_TOKEN_GOES_HERE');
// lookup your IP address information
ipfinder.Authentication().then(data => {
console.log(data);
// console.log(data.status_message);
}).catch(console.log);
Get IP address
const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder('YOUR_TOKEN_GOES_HERE');
// GET Get details for 1.0.0.0
var ip_address = '1.0.0.0';
// lookup IP address information
ipfinder.getAddressInfo("1.0.0.0").then(data => {
console.log(data);
// console.log(data.status_message);
}).catch(console.log);
Get ASN
This API available as part of our Pro and enterprise https://ipfinder.io/pricing.
const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder('YOUR_TOKEN_GOES_HERE');
var asn = 'as36947';
// lookup Asn information
ipfinder.getAsn("as1").then(data => {
console.log(data);
// console.log(data.status_message);
}).catch(console.log);
Firewall
This API available as part of our enterprise https://ipfinder.io/pricing.
formats supported are : apache_allow
, apache_deny
,nginx_allow
,nginx_deny
, CIDR
, linux_iptables
, netmask
, inverse_netmask
, web_config_allow
, web_config_deny
, cisco_acl
, peer_guardian_2
, network_object
, cisco_bit_bucket
, juniper_junos
, microtik
const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder('YOUR_TOKEN_GOES_HERE');
var asn = 'as36947';
// lookup Asn Firewall information
ipfinder.getFirewall("AS1", 'nginx_deny').then(data => {
console.log(data);
// console.log(data.status_message);
}).catch(console.log);
Get IP Address Ranges
This API available as part of our enterprise https://ipfinder.io/pricing.
const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder('YOUR_TOKEN_GOES_HERE');
// Organization name
var org = 'Telecom Algeria';
// lookup Organization information
ipfinder.getRanges("Telecom Algeria").then(data => {
console.log(data);
// console.log(data.status_message);
}).catch(console.log);
Get service status
const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder('YOUR_TOKEN_GOES_HERE');
// lookup IP TOKEN information
ipfinder.getStatus().then(data => {
console.log(data);
// console.log(data.status_message);
}).catch(console.log);
Get Domain IP
const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder('YOUR_TOKEN_GOES_HERE');
// domain name
ipfinder.getDomain("google.com").then(data => {
console.log(data);
// console.log(data.status_message);
}).catch(console.log);
Get Domain IP history
const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder('YOUR_TOKEN_GOES_HERE');
// domain name IP history
ipfinder.getDomainHistory("google.com").then(data => {
console.log(data);
// console.log(data.status_message);
}).catch(console.log);
Get list Domain By ASN, Country,Ranges
const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder('YOUR_TOKEN_GOES_HERE');
// list live domain by country DZ,US,TN,FR,MA
ipfinder.getDomainBy("DZ").then(data => {
console.log(data);
// console.log(data.status_message);
}).catch(console.log);
Add proxy
const Ipfinder = require('ipfinder');
const ipfinder = new Ipfinder('YOUR_TOKEN_GOES_HERE', 'https://ipfinder.yourdomain.com');
Sample codes under examples/ folder.
Contact
Contact Us With Additional Questions About Our API, if you would like more information about our API that isn’t available in our IP geolocation API developer documentation, simply contact us at any time and we’ll be able to help you find what you need.