Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ipfinder-io/ip-finder-node
Official Node.js client library for IPfinder
https://github.com/ipfinder-io/ip-finder-node
asn country enterprise firewall geoip geojson geolocation ipfinder ipv4 ipv6 ranges
Last synced: 16 days ago
JSON representation
Official Node.js client library for IPfinder
- Host: GitHub
- URL: https://github.com/ipfinder-io/ip-finder-node
- Owner: ipfinder-io
- License: apache-2.0
- Created: 2019-07-16T14:31:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T07:50:42.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T05:22:20.706Z (3 months ago)
- Topics: asn, country, enterprise, firewall, geoip, geojson, geolocation, ipfinder, ipv4, ipv6, ranges
- Language: JavaScript
- Homepage: https://ipfinder.io
- Size: 1.06 MB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# IPFinder Node.js Client Library
[](https://badge.fury.io/js/ipfinder)
The official Node.js client library for the [IPFinder.io](https://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](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](https://ipfinder.io/pricing).
## Documentation
See the [official documentation](https://ipfinder.io/docs).
## Installation
Installing using npm or yarn:
```shell
npm install ipfinder
# or
yarn add ipfinder
```
## With `free` TOKEN
```javascript
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
```javascript
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
```javascript
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](https://ipfinder.io/pricing).
```javascript
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](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`
```javascript
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](https://ipfinder.io/pricing).
```javascript
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
```javascript
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
```javascript
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
```javascript
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
```javascript
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
```javascript
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](https://ipfinder.io/contact) us at any time and we’ll be able to help you find what you need.
## License
----
[](https://github.com/ipfinder-io/ip-finder-node)