IPInfo-Python: A Python wrapper for the IPInfo API.

IPInfo-Python is a lightweight wrapper for the IPInfo API, which provides up-to-date IP address data.

Contents

1 Usage
2 Authentication
3 Details Data
4 Caching
- 4.1 Modifying cache options
- 4.2 Using a different cache
5 Internationalization

1 Usage

The IPInfo.getDetails() method accepts an IP address as an optional, positional argument. If no IP address is specified, the API will return data for the IP address from which it receives the request.

>>> import ipinfo
>>> access_token = '123456789abc'
>>> handler = ipinfo.getHandler(access_token)
>>> ip_address = '216.239.36.21'
>>> details = handler.getDetails(ip_address)
>>> details.city
Emeryville
>>> details.loc
37.8342,-122.2900

2 Authentication

The IPInfo library can be authenticated with your IPInfo API token, which is passed in as a positional argument. It also works without an authentication token, but in a more limited capacity.

>>> access_token = '123456789abc'
>>> handler = ipinfo(access_token)

3 Details Data

handler.getDetails() will return a Details object that contains all fields listed IPInfo developer docs with a few minor additions. Properties can be accessed directly.

>>> details.hostname
cpe-104-175-221-247.socal.res.rr.com

3.1 Country Name

details.country_name will return the country name, as supplied by the countries.json file. See below for instructions on changing that file for use with non-English languages. details.country will still return country code.

>>> details.country
US
>>> details.country_name
United States

3.2 IP Address

details.ip_address will return the an ipaddress object from the Python Standard Library. details.ip will still return a string.

>>> details.ip
104.175.221.247
>>> type(details.ip)
<class 'str'>
>>> details.ip_address
104.175.221.247
>>> type(details.ip_address)
<class 'ipaddress.IPv4Address'>

3.3 Longitude and Latitude

details.latitude and details.longitude will return latitude and longitude, respectively, as strings. details.loc will still return a composite string of both values.

>>> details.loc
34.0293,-118.3570
>>> details.latitude
34.0293
>>> details.longitude
-118.3570

3.4 Accessing all properties

details.all will return all details data as a dictionary.

>>> details.all
    {
    'asn': {  'asn': 'AS20001',
               'domain': 'twcable.com',
               'name': 'Time Warner Cable Internet LLC',
               'route': '104.172.0.0/14',
               'type': 'isp'},
    'city': 'Los Angeles',
    'company': {   'domain': 'twcable.com',
                   'name': 'Time Warner Cable Internet LLC',
                   'type': 'isp'},
    'country': 'US',
    'country_name': 'United States',
    'hostname': 'cpe-104-175-221-247.socal.res.rr.com',
    'ip': '104.175.221.247',
    'ip_address': IPv4Address('104.175.221.247'),
    'loc': '34.0293,-118.3570',
    'latitude': '34.0293',
    'longitude': '-118.3570',
    'phone': '323',
    'postal': '90016',
    'region': 'California'
    }

4 Caching

In-memory caching of details data is provided by default via the cachetools library. This uses an LRU (least recently used) cache with a TTL (time to live) by default. This means that values will be cached for the specified duration; if the cache's max size is reached, cache values will be invalidated as necessary, starting with the oldest cached value.

4.1 Modifying cache options

Cache behavior can be modified by setting the cache_options keyword argument. cache_options is a dictionary in which the keys are keyword arguments specified in the cachetools library. The nesting of keyword arguments is to prevent name collisions between this library and its dependencies.

Default maximum cache size: 4096 (multiples of 2 are recommended to increase efficiency)
Default TTL: 24 hours (in seconds)

>>> handler = ipinfo(cache_options={'ttl':30, 'maxsize': 128})

4.2 Using a different cache

It's possible to use a custom cache by creating a child class of the CacheInterface class and passing this into the handler object with the cache keyword argument. FYI this is known as the Strategy Pattern.

>>> handler = ipinfo(cache=my_fancy_custom_class)

5 Internationalization

When looking up an IP address, the response object includes a details.country_name attribute which includes the country name based on American English. It is possible to return the country name in other languages by setting the countries_file keyword argument when creating the IPInfo object.

The file must be a .json file with the following structure:

{
 "BD": "Bangladesh",
 "BE": "Belgium",
 "BF": "Burkina Faso",
 "BG": "Bulgaria"
 ...
}

jhtimmins / test-ipinfo