Official Python Library for IPinfo API (IP geolocation and other types of IP data)
This is the official Python client library for the IPinfo.io IP address API, allowing you to lookup your own IP address, or get any of the following details for an IP:
You'll need an IPinfo API access token, which you can get by singing up for a free account at https://ipinfo.io/signup.
The free plan is limited to 50,000 requests per month, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see https://ipinfo.io/pricing
pip install ipinfo
>>> import ipinfo >>> access_token = '123456789abc' >>> handler = ipinfo.getHandler(access_token) >>> ip_address = '216.239.36.21' >>> details = handler.getDetails(ip_address) >>> details.city 'Mountain View' >>> details.loc '37.3861,-122.0840'
An asynchronous handler is available as well, and can be accessed and used in almost the same exact way as the synchronous handler:
>>> import ipinfo >>> access_token = '123456789abc' >>> handler = ipinfo.getHandlerAsync(access_token) >>> ip_address = '216.239.36.21' >>> async def do_req(): ... details = await handler.getDetails(ip_address) ... print(details.city) ... print(details.loc) ... >>> >>> import asyncio >>> loop = asyncio.get_event_loop() >>> loop.run_until_complete(do_req()) Mountain View 37.4056,-122.0775 >>> >>> ip_address = '1.1.1.1' >>> loop.run_until_complete(do_req()) New York City 40.7143,-74.0060
Internally the library uses
aiohttp, but as long as you provide an event loop (as in this example via
asyncio), it shouldn't matter.
The
Handler.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) >>> details = handler.getDetails() >>> details.city 'Mountain View' >>> details.loc '37.3861,-122.0840'
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.
>>> import ipinfo >>> handler = ipinfo.getHandler(access_token='123456789abc')
handler.getDetails()will return a
Detailsobject that contains all fields listed in the IPinfo developer docs with a few minor additions. Properties can be accessed directly.
>>> details.hostname 'any-in-2415.1e100.net'
details.country_namewill return the country name, as supplied by the
countries.jsonfile. See below for instructions on changing that file for use with non-English languages.
details.countrywill still return country code.
>>> details.country 'US' >>> details.country_name 'United States'
details.latitudeand
details.longitudewill return latitude and longitude, respectively, as strings.
details.locwill still return a composite string of both values.
>>> details.loc '37.3861,-122.0840' >>> details.latitude '37.3861' >>> details.longitude '-122.0840'
details.allwill return all details data as a dictionary.
>>> import pprint >>> pprint.pprint(details.all) {'abuse': {'address': 'US, CA, Mountain View, 1600 Amphitheatre Parkway, 94043', 'country': 'US', 'email': '[email protected]', 'name': 'Abuse', 'network': '216.239.32.0/19', 'phone': '+1-650-253-0000'}, 'asn': {'asn': 'AS15169', 'domain': 'google.com', 'name': 'Google LLC', 'route': '216.239.36.0/24', 'type': 'business'}, 'city': 'Mountain View', 'company': {'domain': 'google.com', 'name': 'Google LLC', 'type': 'business'}, 'country': 'US', 'country_name': 'United States', 'hosting': {'host': 'google', 'id': 'GOOGLE', 'name': 'Google LLC', 'network': '216.239.32.0/19'}, 'hostname': 'any-in-2415.1e100.net', 'ip': '216.239.36.21', 'latitude': '37.3861', 'loc': '37.3861,-122.0840', 'longitude': '-122.0840', 'postal': '94035', 'region': 'California', 'timezone': 'America/Los_Angeles'}
In-memory caching of
detailsdata 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.
Cache behavior can be modified by setting the
cache_optionskeyword argument.
cache_optionsis a dictionary in which the keys are keyword arguments specified in the
cachetoolslibrary. The nesting of keyword arguments is to prevent name collisions between this library and its dependencies.
>>> import ipinfo >>> handler = ipinfo.getHandler(cache_options={'ttl':30, 'maxsize': 128})
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
cachekeyword argument. FYI this is known as the Strategy Pattern.
import ipinfo from ipinfo.cache.interface import CacheInterfaceclass MyCustomCache(CacheInterface): ...
handler = ipinfo.getHandler(cache=MyCustomCache())
Note: the asynchronous handler currently only accepts the
timeoutoption, input the same way as shown below.
Request behavior can be modified by setting the
request_optionskeyword argument.
request_optionsis a dictionary in which the keys are keyword arguments specified in the
requestslibrary. The nesting of keyword arguments is to prevent name collisions between this library and its dependencies.
>>> handler = ipinfo.getHandler(request_options={'timeout': 4})
When looking up an IP address, the response object includes a
details.country_nameattribute which includes the country name based on American English. It is possible to return the country name in other languages by setting the
countries_filekeyword argument when creating the
IPinfoobject.
The file must be a
.jsonfile with the following structure:
{ "BD": "Bangladesh", "BE": "Belgium", "BF": "Burkina Faso", "BG": "Bulgaria", ... }
Looking up a single IP at a time can be slow. It could be done concurrently from the client side, but IPinfo supports a batch endpoint to allow you to group together IPs and let us handle retrieving details for them in bulk for you.
>>> import ipinfo, pprint >>> access_token = '123456789abc' >>> handler = ipinfo.getHandler(access_token) >>> pprint.pprint(handler.getBatchDetails([ ... '1.1.1.1', ... '8.8.8.8', ... '1.2.3.4/country', ... ])) {'1.1.1.1': {'city': '', 'country': 'AU', 'country_name': 'Australia', 'hostname': 'one.one.one.one', 'ip': '1.1.1.1', 'latitude': '-33.4940', 'loc': '-33.4940,143.2100', 'longitude': '143.2100', 'org': 'AS13335 Cloudflare, Inc.', 'region': ''}, '1.2.3.4/country': 'US', '8.8.8.8': {'city': 'Mountain View', 'country': 'US', 'country_name': 'United States', 'hostname': 'dns.google', 'ip': '8.8.8.8', 'latitude': '37.3860', 'loc': '37.3860,-122.0838', 'longitude': '-122.0838', 'org': 'AS15169 Google LLC', 'postal': '94035', 'region': 'California', 'timezone': 'America/Los_Angeles'}}
The input size is not limited, as the interface will chunk operations for you behind the scenes.
Please see the official documentation for more information and limitations.
There are official IPinfo client libraries available for many languages including PHP, Go, Java, Ruby, and many popular frameworks such as Django, Rails and Laravel. There are also many third party libraries and integrations available for our API.
Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier, VPN detection, hosted domains, and IP type data sets. Our API handles over 20 billion requests a month for 100,000 businesses and developers.