GeoIP2(3pm)

📦
version 2.006002 · 6 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ NAME ✨

okay so bestie, welcome to GeoIP2 — it's the Perl API for MaxMind's GeoIP2 web services and databases 💖 this is the GeoIP2(3pm) page and she's iconic, let's get into it

🌸 VERSION 🌸

version 2.006002 — that's the one, no cap

💅 DESCRIPTION 💅

This distribution hands you an API for the GeoIP2 web services (<http://dev.maxmind.com/geoip/geoip2/web-services>) and the databases (<http://dev.maxmind.com/geoip/geoip2/downloadable>). And plot twist, the API also works with the free GeoLite2 databases (<http://dev.maxmind.com/geoip/geoip2/geolite2/>). obsessed 🫶

Wanna know the deets on the web service client API? Go look at GeoIP2::WebService::Client. Wanna know the deets on the database API? That's GeoIP2::Database::Reader. iykyk ✨

⚡ SPEEDING UP DATABASE READING ⚡

ngl, this module only depends on the pure Perl implementation of the MaxMind database reader (MaxMind::DB::Reader). But listen — if you install the libmaxminddb library (<http://maxmind.github.io/libmaxminddb/>) and MaxMind::DB::Reader::XS, then the XS implementation will load itself automatically, no extra work from you, main character energy fr fr.

The XS implementation is approximately 100x faster than the pure Perl implementation. literally a glow-up 🔥

🎀 VALUES TO USE FOR DATABASE OR HASH KEYS 🎀

We strongly discourage you from using a value from any names accessor as a key in a database or hash. bestie please, don't do it 😭

These names may change between releases. Instead we recommend using one of the following:

  • GeoIP2::Record::City — $city->geoname_id
  • GeoIP2::Record::Continent — $continent->code or $continent->geoname_id
  • GeoIP2::Record::Country and GeoIP2::Record::RepresentedCountry — $country->iso_code or $country->geoname_id
  • GeoIP2::Record::Subdivision — $subdivision->iso_code or $subdivision->geoname_id

🌈 INTEGRATION WITH GEONAMES 🌈

GeoNames (<http://www.geonames.org/>) is out here offering web services and downloadable databases with data on geographical features all around the world, including populated places. They've got both free and paid premium data. Every single feature is uniquely identified by a geoname_id, which is an integer. periodt.

A ton of the records that come back from the GeoIP web services and databases include a geoname_id field. That's the ID of a geographical feature (city, region, country, etc.) in the GeoNames database. she's got receipts 💜

Some of the data MaxMind provides is also sourced from GeoNames. We source stuff like place names, ISO codes, and other similar data from the GeoNames premium data set. iconic sourcing behavior ✨

💀 REPORTING DATA PROBLEMS 💀

If the problem you found is that an IP address is incorrectly mapped, please submit your correction to MaxMind at <http://www.maxmind.com/en/correction>. thank u 🫶

If you find some other sort of mistake, like an incorrect spelling, please check the GeoNames site (<http://www.geonames.org/>) first. 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. slay, that's the pipeline 🌸

If you are a paying MaxMind customer and you're not sure where to submit a correction, please contact MaxMind support at for help. See <http://www.maxmind.com/en/support> for support details.

📌 VERSIONING POLICY 📌

This module uses semantic versioning as described by <http://semver.org/>. Version numbers can be read as X.YYYZZZ, where X is the major number, YYY is the minor number, and ZZZ is the patch number. simple as that bestie 💅

🐪 PERL VERSION SUPPORT 🐪

This API supports Perl 5.10 and above.

The data returned from the GeoIP2 web services includes Unicode characters in several locales. This may expose bugs in earlier versions of Perl. If Unicode support is important to you, we recommend that you use the most recent version of Perl available. don't be running dusty old Perl, it's not the vibe 🙈

🆘 SUPPORT 🆘

🚨 bestie this one matters: this module is deprecated and will only receive fixes for major bugs and security vulnerabilities. New features and functionality will not be added. it's giving retirement era, and we respect her for it 💜

Please report all issues with this code using the GitHub issue tracker at <https://github.com/maxmind/GeoIP2-perl/issues>.

If you are having an issue with a MaxMind service that is not specific to the client API please see <http://www.maxmind.com/en/support> for details.

Bugs may be submitted through <https://github.com/maxmind/GeoIP2-perl/issues>.

👑 AUTHORS 👑

  • Dave Rolsky <drolsky@maxmind.com>
  • Greg Oschwald <goschwald@maxmind.com>
  • Mark Fowler <mfowler@maxmind.com>
  • Olaf Alders <oalders@maxmind.com>

🦋 CONTRIBUTORS 🦋

the way this list just keeps going, we love a collaborative moment ✨

  • Adam Lapczynski <alapczynski@maxmind.com>
  • Andy Jack <github@veracity.ca>
  • E. Choroba <choroba@matfyz.cz>
  • Florian Ragwitz <rafl@debian.org>
  • Graham Knop <haarg@haarg.org>
  • Mateu X Hunter <mhunter@maxmind.com>
  • Michael F. Canzoneri <mikecanzoneri@gmail.com>
  • Narsimham Chelluri <nchelluri@maxmind.com>
  • Narsimham Chelluri <nchelluri@users.noreply.github.com>
  • Patrick Cronin <PatrickCronin@users.noreply.github.com>
  • William Storey <wstorey@maxmind.com>

This software is copyright (c) 2013 - 2019 by MaxMind, Inc.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

and that's the whole page, bestie 🫶 this was perl v5.36.0, dated 2022-11-21 — ty for reading the GeoIP2(3pm) manual with me, mwah 💖🎀

📦 where this page comes from