The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
GeoIP2-0.0100
River stage one • 2 direct dependents • 2 total dependents
16 ++
/ GeoIP2::Record::City

NAME

GeoIP2::Record::City - Contains data for the city record associated with an IP address

VERSION

version 0.0100

SYNOPSIS

  use 5.008;

  use GeoIP2::Webservice::Client;

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

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

  my $city_rec = $city->city();
  say $city_rec->name();

DESCRIPTION

This class contains the city-level data associated with an IP address.

This record is returned by all the end points except the Country end point.

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.

This attribute is only available from the Omni end point.

$city_rec->geoname_id()

This returns a geoname_id for the city.

This attribute is returned by all end points.

$city_rec->name()

This returns a name for the city. The language chosen depends on the languages 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.

If the record does not have a name in any of languages you asked for, this method returns undef.

This attribute is returned by all end points.

$city_rec->names()

This returns a hash reference where the keys are language codes and the values are names. See GeoIP2::Webservice::Client for a list of the possible language codes.

This attribute is returned by all end points.

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2013 by MaxMind, Inc..

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)