Package: geoip2
DescriptionThis package provides an API for the GeoIP2 and GeoLite2web servicesanddatabases.InstallationTo install thegeoip2module, type:$pipinstallgeoip2If you are not able to use pip, you may also use easy_install from the
source directory:$easy_install.Database Reader ExtensionIf you wish to use the C extension for the database reader, you must first
install thelibmaxminddb C API.
Pleasesee the instructions distributed with it.IP Geolocation UsageIP geolocation is inherently imprecise. Locations are often near the center of
the population. Any location provided by a GeoIP2 database or web service
should not be used to identify a particular address or household.Web Service UsageTo use this API, you first construct either ageoip2.webservice.Clientorgeoip2.webservice.AsyncClient, passing your MaxMindaccount_idandlicense_keyto the constructor. To use the GeoLite2 web service instead of
the GeoIP2 web service, set the optionalhostkeyword argument togeolite.info. To use the Sandbox GeoIP2 web service instead of the
production GeoIP2 web service, set the optionalhostkeyword argument tosandbox.maxmind.com.After doing this, you may call the method corresponding to request type
(e.g.,cityorcountry), passing it the IP address you want to look up.If the request succeeds, the method call will return a model class for the
endpoint you called. This model in turn contains multiple record classes,
each of which represents part of the data returned by the web service.If the request fails, the client class throws an exception.Sync Web Service Example>>>importgeoip2.webservice>>>>>># This creates a Client object that can be reused across requests.>>># Replace "42" with your account ID and "license_key" with your license>>># key. Set the "host" keyword argument to "geolite.info" to use the>>># GeoLite2 web service instead of the GeoIP2 web service. Set the>>># "host" keyword argument to "sandbox.maxmind.com" to use the Sandbox>>># GeoIP2 web service instead of the production GeoIP2 web service.>>>withgeoip2.webservice.Client(42,'license_key')asclient:>>>>>># Replace "city" with the method corresponding to the web service>>># that you are using, i.e., "country", "city", or "insights". Please>>># note that Insights is not supported by the GeoLite2 web service.>>>response=client.city('203.0.113.0')>>>>>>response.country.iso_code'US'>>>response.country.name'United States'>>>response.country.names['zh-CN']u'美国'>>>>>>response.subdivisions.most_specific.name'Minnesota'>>>response.subdivisions.most_specific.iso_code'MN'>>>>>>response.city.name'Minneapolis'>>>>>>response.postal.code'55455'>>>>>>response.location.latitude44.9733>>>response.location.longitude-93.2323>>>>>>response.traits.networkIPv4Network('203.0.113.0/32')Async Web Service Example>>>importasyncio>>>>>>importgeoip2.webservice>>>>>>asyncdefmain():>>># This creates an AsyncClient object that can be reused across>>># requests on the running event loop. If you are using multiple event>>># loops, you must ensure the object is not used on another loop.>>>#>>># Replace "42" with your account ID and "license_key" with your license>>># key. Set the "host" keyword argument to "geolite.info" to use the>>># GeoLite2 web service instead of the GeoIP2 web service. Set the>>># "host" keyword argument to "sandbox.maxmind.com" to use the Sandbox>>># GeoIP2 web service instead of the production GeoIP2 web service.>>>asyncwithgeoip2.webservice.AsyncClient(42,'license_key')asclient:>>>>>># Replace "city" with the method corresponding to the web service>>># that you are using, i.e., "country", "city", or "insights". Please>>># note that Insights is not supported by the GeoLite2 web service.>>>response=awaitclient.city('203.0.113.0')>>>>>>response.country.iso_code'US'>>>response.country.name'United States'>>>response.country.names['zh-CN']u'美国'>>>>>>response.subdivisions.most_specific.name'Minnesota'>>>response.subdivisions.most_specific.iso_code'MN'>>>>>>response.city.name'Minneapolis'>>>>>>response.postal.code'55455'>>>>>>response.location.latitude44.9733>>>response.location.longitude-93.2323>>>>>>response.traits.networkIPv4Network('203.0.113.0/32')>>>>>>asyncio.run(main())Web Service Client ExceptionsFor details on the possible errors returned by the web service itself, seehttps://dev.maxmind.com/geoip/docs/web-services?lang=enfor the GeoIP2 web
service docs.If the web service returns an explicit error document, this is thrown as aAddressNotFoundError,AuthenticationError,InvalidRequestError, orOutOfQueriesErroras appropriate. These all subclassGeoIP2Error.If some other sort of error occurs, this is thrown as anHTTPError. This
is thrown when some sort of unanticipated error occurs, such as the web
service returning a 500 or an invalid error document. If the web service
returns any status code besides 200, 4xx, or 5xx, this also becomes anHTTPError.Finally, if the web service returns a 200 but the body is invalid, the client
throws aGeoIP2Error.Database UsageTo use the database API, you first construct ageoip2.database.Readerusing
the path to the file as the first argument. After doing this, you may call the
method corresponding to database type (e.g.,cityorcountry), passing it
the IP address you want to look up.If the lookup succeeds, the method call will return a model class for the
database method you called. This model in turn contains multiple record classes,
each of which represents part of the data for the record.If the request fails, the reader class throws an exception.Database ExampleCity Database>>>importgeoip2.database>>>>>># This creates a Reader object. You should use the same object>>># across multiple requests as creation of it is expensive.>>>withgeoip2.database.Reader('/path/to/GeoLite2-City.mmdb')asreader:>>>>>># Replace "city" with the method corresponding to the database>>># that you are using, e.g., "country".>>>response=reader.city('203.0.113.0')>>>>>>response.country.iso_code'US'>>>response.country.name'United States'>>>response.country.names['zh-CN']u'美国'>>>>>>response.subdivisions.most_specific.name'Minnesota'>>>response.subdivisions.most_specific.iso_code'MN'>>>>>>response.city.name'Minneapolis'>>>>>>response.postal.code'55455'>>>>>>response.location.latitude44.9733>>>response.location.longitude-93.2323>>>>>>response.traits.networkIPv4Network('203.0.113.0/24')Anonymous IP Database>>>importgeoip2.database>>>>>># This creates a Reader object. You should use the same object>>># across multiple requests as creation of it is expensive.>>>withgeoip2.database.Reader('/path/to/GeoIP2-Anonymous-IP.mmdb')asreader:>>>>>>response=reader.anonymous_ip('203.0.113.0')>>>>>>response.is_anonymousTrue>>>response.is_anonymous_vpnFalse>>>response.is_hosting_providerFalse>>>response.is_public_proxyFalse>>>response.is_residential_proxyFalse>>>response.is_tor_exit_nodeTrue>>>response.ip_address'203.0.113.0'>>>response.networkIPv4Network('203.0.113.0/24')ASN Database>>>importgeoip2.database>>>>>># This creates a Reader object. You should use the same object>>># across multiple requests as creation of it is expensive.>>>withgeoip2.database.Reader('/path/to/GeoLite2-ASN.mmdb')asreader:>>>response=reader.asn('203.0.113.0')>>>response.autonomous_system_number1221>>>response.autonomous_system_organization'Telstra Pty Ltd'>>>response.ip_address'203.0.113.0'>>>response.networkIPv4Network('203.0.113.0/24')Connection-Type Database>>>importgeoip2.database>>>>>># This creates a Reader object. You should use the same object>>># across multiple requests as creation of it is expensive.>>>withgeoip2.database.Reader('/path/to/GeoIP2-Connection-Type.mmdb')asreader:>>>response=reader.connection_type('203.0.113.0')>>>response.connection_type'Corporate'>>>response.ip_address'203.0.113.0'>>>response.networkIPv4Network('203.0.113.0/24')Domain Database>>>importgeoip2.database>>>>>># This creates a Reader object. You should use the same object>>># across multiple requests as creation of it is expensive.>>>withgeoip2.database.Reader('/path/to/GeoIP2-Domain.mmdb')asreader:>>>response=reader.domain('203.0.113.0')>>>response.domain'umn.edu'>>>response.ip_address'203.0.113.0'Enterprise Database>>>importgeoip2.database>>>>>># This creates a Reader object. You should use the same object>>># across multiple requests as creation of it is expensive.>>>withgeoip2.database.Reader('/path/to/GeoIP2-Enterprise.mmdb')asreader:>>>>>># Use the .enterprise method to do a lookup in the Enterprise database>>>response=reader.enterprise('203.0.113.0')>>>>>>response.country.confidence99>>>response.country.iso_code'US'>>>response.country.name'United States'>>>response.country.names['zh-CN']u'美国'>>>>>>response.subdivisions.most_specific.name'Minnesota'>>>response.subdivisions.most_specific.iso_code'MN'>>>response.subdivisions.most_specific.confidence77>>>>>>response.city.name'Minneapolis'>>>response.country.confidence11>>>>>>response.postal.code'55455'>>>>>>response.location.accuracy_radius50>>>response.location.latitude44.9733>>>response.location.longitude-93.2323>>>>>>response.traits.networkIPv4Network('203.0.113.0/24')ISP Database>>>importgeoip2.database>>>>>># This creates a Reader object. You should use the same object>>># across multiple requests as creation of it is expensive.>>>withgeoip2.database.Reader('/path/to/GeoIP2-ISP.mmdb')asreader:>>>response=reader.isp('203.0.113.0')>>>response.autonomous_system_number1221>>>response.autonomous_system_organization'Telstra Pty Ltd'>>>response.isp'Telstra Internet'>>>response.organization'Telstra Internet'>>>response.ip_address'203.0.113.0'>>>response.networkIPv4Network('203.0.113.0/24')Database Reader ExceptionsIf the database file does not exist or is not readable, the constructor will
raise aFileNotFoundErroror aPermissionError. If the IP address passed
to a method is invalid, aValueErrorwill be raised. If the file is invalid
or there is a bug in the reader, amaxminddb.InvalidDatabaseErrorwill be
raised with a description of the problem. If an IP address is not in the
database, aAddressNotFoundErrorwill be raised.AddressNotFoundErrorreferences the largest subnet where no address would be
found. This can be used to efficiently enumerate entire subnets:importgeoip2.databaseimportgeoip2.errorsimportipaddress# This creates a Reader object. You should use the same object# across multiple requests as creation of it is expensive.withgeoip2.database.Reader('/path/to/GeoLite2-ASN.mmdb')asreader:network=ipaddress.ip_network("192.128.0.0/15")ip_address=network[0]whileip_addressinnetwork:try:response=reader.asn(ip_address)response_network=response.networkexceptgeoip2.errors.AddressNotFoundErrorase:response=Noneresponse_network=e.networkprint(f"{response_network}:{response!r}")ip_address=response_network[-1]+1# move to next subnetValues to use for Database or Dictionary KeysWe strongly discourage you from using a value from any ``names`` property as
a key in a database or dictionaries.These names may change between releases. Instead we recommend using one of the
following:geoip2.records.City-city.geoname_idgeoip2.records.Continent-continent.codeorcontinent.geoname_idgeoip2.records.Countryandgeoip2.records.RepresentedCountry-country.iso_codeorcountry.geoname_idgeoip2.records.subdivision-subdivision.iso_codeorsubdivision.geoname_idWhat data is returned?While many of the models contain the same basic records, the attributes which
can be populated vary between web service endpoints or databases. In
addition, while a model may offer a particular piece of data, MaxMind does not
always have every piece of data for any given IP address.Because of these factors, it is possible for any request to return a record
where some or all of the attributes are unpopulated.The only piece of data which is always returned is theip_addressattribute in thegeoip2.records.Traitsrecord.Integration with GeoNamesGeoNamesoffers web services and downloadable
databases with data on geographical features around the world, including
populated places. They offer both free and paid premium data. Each feature is
uniquely identified by ageoname_id, which is an integer.Many of the records returned by the GeoIP web services and databases include ageoname_idfield. This is the ID of a geographical feature (city, region,
country, etc.) in the GeoNames database.Some of the data that MaxMind provides is also sourced from GeoNames. We
source things like place names, ISO codes, and other similar data from the
GeoNames premium data set.Reporting Data ProblemsIf the problem you find is that an IP address is incorrectly mapped, pleasesubmit your correction to MaxMind.If you find some other sort of mistake, like an incorrect spelling, please
check theGeoNames sitefirst. Once you’ve
searched for a place and found it on the GeoNames map view, there are a
number of links you can use to correct data (“move”, “edit”, “alternate
names”, etc.). Once the correction is part of the GeoNames data set, it
will be automatically incorporated into future MaxMind releases.If you are a paying MaxMind customer and you’re not sure where to submit a
correction, pleasecontact MaxMind supportfor help.RequirementsPython 3.8 or greater is required. Older versions are not supported.The Requests HTTP library is also required. See
<https://pypi.org/project/requests/> for details.VersioningThe GeoIP2 Python API usesSemantic Versioning.SupportPlease report all issues with this code using theGitHub issue trackerIf you are having an issue with a MaxMind service that is not specific to the
client API, please contactMaxMind supportfor assistance.