View all files | ||||
This is the official Django client library for the IPinfo.io IP address API, allowing you to look up your own IP address, or get any of the following details for an IP:
Check all the data we have for your IP address here.
You'll need an IPinfo API access token, which you can get by signing 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
The library also supports the Lite API, see the Lite API section for more info.
Once configured, ipinfo_django will make IP address data accessible within Django's HttpRequest object. The following view from the view.py file:
will return the following as an HttpResponse object:
To get the details of a user-defined IP, we will import the ipinfo package directly to the view.py file:
The above code will print the IP details provided. We can use GET and POST methods to get the details of user-defined IP
Setup can be accomplished in three steps:
'ipinfo_django.middleware.IPinfoAsyncMiddleware' can be used under ASGI. This is an async-only middleware that works only when placed in an async middleware chain, that is, a chain of Django middleware which are both async and async capable. For example:
See asynchronous-support for more.
HttpRequest.ipinfo is a Details object that contains all fields listed IPinfo developer docs with a few minor additions. Properties can be accessed directly.
HttpRequest.ipinfo.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. HttpRequest.ipinfo.country will still return country code.
HttpRequest.ipinfo.ip will return an IP string.
HttpRequest.ipinfo.latitude and HttpRequest.ipinfo.longitude will return latitude and longitude, respectively, as strings. HttpRequest.ipinfo.loc will still return a composite string of both values.
HttpRequest.ipinfo.all will return all details data as a dictionary.
The IPinfo library can be authenticated with your IPinfo API token, which is set in the settings.py file. It also works without an authentication token, but in a more limited capacity. From settings.py:
In-memory caching of details data is provided by default via the cachetools <https://cachetools.readthedocs.io/en/latest/>_ 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_options key in settings.IPINFO_SETTINGS. 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.
From settings.py:
It's possible to use a custom cache by creating a child class of the CacheInterface class and setting the cache value in settings.IPINFO_SETTINGS. FYI this is known as the Strategy Pattern.
From settings.py:
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 in settings.py.
The file must be a .json file with the following structure:
From settings.py:
By default, ipinfo_django filters out requests that have bot or spider in the user-agent. Instead of looking up IP address data for these requests, the HttpRequest.ipinfo attribute is set to None. This is to prevent you from unnecessarily using up requests on non-user traffic. This behavior can be switched off by modifying the settings.IPINFO_FILTER object in settings.py.
To turn off filtering:
To set your own filtering rules, thereby replacing the default filter, you can set settings.IPINFO_FILTER to your own, custom callable function which satisfies the following rules:
To use your own filter rules:
By default, the IP is used by ignoring the reverse proxies depending on whether we are behind a reverse proxy or not.
Since the desired IP by your system may be in other locations, the IP selection mechanism is configurable and some alternative built-in options are available.
A DefaultIPSelector object is used by default if no IP selection mechanism is provided. It selects an IP address by trying to extract it from the X-Forwarded-For header. It will default to the source IP on the request if the header doesn't exist.
This selector can be set explicitly by setting the IPINFO_IP_SELECTOR in settings.py file.
A ClientIPSelector returns the client IP address from the incoming request.
This selector can be set by setting the IPINFO_IP_SELECTOR in settings.pyfile.
In case a custom IP selector is required, you may implement the IPSelectorInterface and pass the instance to IPINFO_IP_SELECTOR in settings.py file.
For example:
If there's an error while making a request to IPinfo (e.g. your token was rate limited, there was a network issue, etc.), then the traceback will be logged using the built-in Python logger, and HttpRequest.ipinfo will be None.
The library gives the possibility to use the Lite API too, authentication with your token is still required.
The IP details returned are slightly different from the Core API middleware, though the arguments are identical.
To use it add 'ipinfo_django.middleware.IPinfoLiteMiddleware' to settings.MIDDLEWARE in settings.py:
We also provide an async Lite API middleware to be used under ASGI. Use 'ipinfo_django.middleware.IPinfoAsyncLiteMiddleware in that case.
The library also supports the Core API, which provides city-level geolocation with nested geo and AS objects. Authentication with your token is required.
To use it add 'ipinfo_django.middleware.IPinfoCoreMiddleware' to settings.MIDDLEWARE in settings.py:
We also provide an async Core API middleware to be used under ASGI. Use 'ipinfo_django.middleware.IPinfoAsyncCoreMiddleware in that case.
The library also supports the Plus API, which provides enhanced data including mobile carrier info and privacy detection. Authentication with your token is required.
To use it add 'ipinfo_django.middleware.IPinfoPlusMiddleware' to settings.MIDDLEWARE in settings.py:
We also provide an async Plus API middleware to be used under ASGI. Use 'ipinfo_django.middleware.IPinfoAsyncPlusMiddleware in that case.
The library also supports the Residential Proxy API, which allows you to check if an IP address is a residential proxy. Authentication with your token is required.
To use it add 'ipinfo_django.middleware.IPinfoResproxyMiddleware' to settings.MIDDLEWARE in settings.py:
The residential proxy details will be available through request.ipinfo_resproxy:
We also provide an async Residential Proxy API middleware to be used under ASGI. Use 'ipinfo_django.middleware.IPinfoAsyncResproxyMiddleware in that case.
To test the project locally, install Tox in your Python virtual environment:
Then, run Tox:
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 40 billion requests a month for businesses and developers.