Skip to content
Official Lua client library for IPfinder
Lua
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
ipfinder
.editorconfig
.gitignore
LICENSE
README.md
changelog.md
ipfinder-1.0.0-1.rockspec

README.md

IP Finder

IPFinder Lua Client Library

The official Lua 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 luarocks:

luarocks install ipfinder

With free TOKEN

local inspect = require('inspect')
local ipfinder = require('ipfinder')

conf = Ipfinder:init() -- emty token == free  or conf = Ipfinder:init(nil) 

-- lookup your IP address information
auth = conf:Authentication()

print(inspect(auth))

Authentication

local inspect = require('inspect')
local ipfinder = require('ipfinder')

accconf Ipfinder:init("YOUR_TOKEN_GOES_HERE")

-- lookup your IP address information
auth = conf:Authentication()

print(inspect(auth))

Get IP address

local inspect = require('inspect')
local ipfinder = require('ipfinder')

conf = Ipfinder:init("YOUR_TOKEN_GOES_HERE")

-- GET Get details for 1.0.0.0
ip = conf:getAddressInfo("1.0.0.0")

print(inspect(ip))

print(ip.ip)

Get ASN

This API available as part of our Pro and enterprise https://ipfinder.io/pricing.

local inspect = require('inspect')
local ipfinder = require('ipfinder')

conf = Ipfinder:init("YOUR_TOKEN_GOES_HERE")

asn = conf:getAsn("AS1")

print(inspect(asn))

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

local inspect = require('inspect')
local ipfinder = require('ipfinder')

conf = Ipfinder:init("YOUR_TOKEN_GOES_HERE")

-- lookup Asn Firewall information
fire = conf:getFirewall("AS1", 'nginx_deny')

print(inspect(fire))

Get IP Address Ranges

This API available as part of our enterprise https://ipfinder.io/pricing.

local inspect = require('inspect')
local ipfinder = require('ipfinder')

conf = Ipfinder:init("YOUR_TOKEN_GOES_HERE")

-- lookup Organization information
range = conf:getRanges("Telecom Algeria")

print(inspect(range))

Get service status

local inspect = require('inspect')
local ipfinder = require('ipfinder')

conf = Ipfinder:init("YOUR_TOKEN_GOES_HERE")

-- lookup IP TOKEN information
status = conf:getStatus()

print(inspect(status))

Get Domain IP

local inspect = require('inspect')
local ipfinder = require('ipfinder')

conf = Ipfinder:init("YOUR_TOKEN_GOES_HERE")

domain = conf:getDomain("google.fr")

print(inspect(domain))

Get Domain IP history

local inspect = require('inspect')
local ipfinder = require('ipfinder')

conf = Ipfinder:init("YOUR_TOKEN_GOES_HERE")
-- domain name IP history
domain = conf:getDomainHistory("google.fr")

print(inspect(domain))

Get list Domain By ASN, Country,Ranges

local inspect = require('inspect')
local ipfinder = require('ipfinder')

conf = Ipfinder:init("YOUR_TOKEN_GOES_HERE")
-- list live domain by country DZ,US,TN,FR,MA

domain = conf:getDomainBy("FR")

print(inspect(domain))

Add proxy

conf = Ipfinder:init("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.

License


GitHub license

You can’t perform that action at this time.