Skip to main content

Official Python library for IPFinder

Project description

IP Finder

IPFinder Python Client Library

The official Python 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 pip:

pip install ipfinder-io

How to Use

usage is quite simple:

With free TOKEN

import ipfinder

config = ipfinder.config() #  emty token == free

# lookup your IP address information
auth = config.Authentication()

auth.details

Authentication

import ipfinder

config = ipfinder.config('YOUR_TOKEN_GOES_HERE')

# lookup your IP address information
auth = config.Authentication()

auth.details

Get IP address

import ipfinder

config = ipfinder.config('YOUR_TOKEN_GOES_HERE')

# GET Get details for 1.0.0.0

ip = config.getAddressInfo('1.0.0.0')

ip.details

# lookup IP address information

Get ASN

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

import ipfinder

config = ipfinder.config('YOUR_TOKEN_GOES_HERE')

# lookup Asn information
asn = config.getAsn('AS1')

asn.details

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

import ipfinder

config = ipfinder.config('YOUR_TOKEN_GOES_HERE')

asn = 'as36947';

# lookup Asn information

data = config.getFirewall(asn, 'nginx_deny')

data.details

Get IP Address Ranges

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

import ipfinder

config = ipfinder.config('YOUR_TOKEN_GOES_HERE')

# Organization name
org = 'Telecom Algeria';

# lookup Organization information
data = config.getRanges(org)

data.details

Get service status

import ipfinder

config = ipfinder.config('YOUR_TOKEN_GOES_HERE')

# lookup TOKEN information
data = config.getStatus()


data.details

Get Domain IP

import ipfinder

config = ipfinder.config('YOUR_TOKEN_GOES_HERE')


#  domain name
name = 'google.com';

data = config.getDomain(name)

data.details

Get Domain IP history

import ipfinder

config = ipfinder.config('YOUR_TOKEN_GOES_HERE')

# domain name
name = 'google.com';

data = config.getDomainHistory(name)

data.details

Get list Domain By ASN, Country,Ranges

import ipfinder

config = ipfinder.config('YOUR_TOKEN_GOES_HERE')

# list live domain by country DZ,US,TN,FR,MA
by = 'DZ';

dby = config.getDomainBy(by)

dby.details

Add proxy

import ipfinder

config = ipfinder.config('YOUR_TOKEN_GOES_HERE','https://ipfinder.yourdomain.com')

Error handling

import ipfinder
try:
    # do something
except Exception as e:
    print('error: ', e)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ipfinder-io, version 1.0.0a1
Filename, size & hash File type Python version Upload date
ipfinder_io-1.0.0a1-py2.py3-none-any.whl (14.7 kB) View hashes Wheel py2.py3
ipfinder-io-1.0.0a1.tar.gz (14.1 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page