GeoIP2...::City(3pm)

✨ NAME ✨

GeoIP2::Record::City — it's the lil record that holds all the city data for an IP address 💖

(it lives in the User Contributed Perl Documentation, so you already know it's a perl thing, bestie 🐪)

---

🌸 VERSION 🌸

version 2.006002 — that's the one, no cap 👑

---

🦋 SYNOPSIS 🦋

okay so here's the whole vibe, in code:

use 5.008;

use GeoIP2::WebService::Client;

my $client = GeoIP2::WebService::Client->new(
    account_id  => 42,
    license_key => 'abcdef123456',
);

my $insights = $client->insights( ip => '24.24.24.24' );

my $city_rec = $insights->city();
print $city_rec->name(), "\n";

like… you spin up a client, you ask for insights on an IP, you grab the city record, you print the name. slay. that's it, that's the whole flow 🎀

---

💜 DESCRIPTION 💜

This class contains the city-level data associated with an IP address. literally what it says on the tin 💅

This record is returned by all the end points except the Country end point. so like… every end point shows up to the party except Country. Country said no. 🙈

---

🌈 METHODS 🌈

This class provides the following methods:

⭐ $city_rec->confidence()

This returns a value from 0-100 indicating MaxMind's confidence that the city is correct. it's giving "how sure are we, on a scale of zero to a hundred" energy 🔥

This attribute is only available from the Insights end point and the GeoIP2 Enterprise database. so if you're not on those, don't come looking for it, bestie 😭

⭐ $city_rec->geoname_id()

This returns a "geoname_id" for the city. it's the city's lil ID number, iykyk 🪪

This attribute is returned by all end points. every single one. periodt 💖

⭐ $city_rec->name()

This returns a name for the city. The locale chosen depends on the "locales" argument that was passed to the record's constructor. This will be passed through from the GeoIP2::WebService::Client object you used to fetch the data that populated this record. so basically the client picks the locale and the record just inherits the vibe ✨

If the record does not have a name in any of the locales you asked for, this method returns "undef". yeah. undef. it happens. don't take it personally 🫶

This attribute is returned by all end points. all of them, always 💯

⭐ $city_rec->names()

This returns a hash reference where the keys are locale codes and the values are names. See GeoIP2::WebService::Client for a list of the possible locale codes. so like, every translation of the city name, all in one hash. iconic 🌍

This attribute is returned by all end points. yes queen, all of them 👑

---

🫶 SUPPORT 🫶

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

(pls be nice when you file one, the maintainers are people too 💜)

---

🧚 AUTHORS 🧚

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

four absolute legends, we stan 💅

---

🎀 COPYRIGHT AND LICENSE 🎀

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.

---

fr fr, that's the whole page. nothing skipped, nothing invented. go forth and look up some cities 💖

k bye bestie, this was perl v5.36.0, dated 2022-11-21, and you just read GeoIP2::Record::City 🦋✨