Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
GeoIP2::Record::LocatiUser)Contributed Perl DocumenGeoIP2::Record::Location(3)

NAME
       GeoIP2::Record::Location	- Contains data	for the	location record
       associated with an IP address

VERSION
       version 2.003005

SYNOPSIS
	 use 5.008;

	 use GeoIP2::WebService::Client;

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

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

	 my $location_rec = $insights->location();
	 print $location_rec->name(), "\n";

DESCRIPTION
       This class contains the location	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:

   $location_rec->accuracy_radius()
       The approximate accuracy	radius in kilometers around the	latitude and
       longitude for the IP address. This is the radius	where we have a	67%
       confidence that the device using	the IP address resides within the
       circle centered at the latitude and longitude with the provided radius.

       This attribute is returned by all end points and	location databases
       except Country.

   $location_rec->average_income()
       This returns a non-negative integer representing	the average income in
       US dollars associated with the requested	IP address.

       This attribute is only available	from the Insights end point and	the
       GeoIP2 Enterprise database.

   $location_rec->latitude()
       The approximate latitude	of the location	associated with	the IP
       address.	This value is not precise and should not be used to identify a
       particular address or household.

       This attribute is returned by all end points and	location databases
       except Country.

   $location_rec->longitude()
       The approximate longitude of the	location associated with the IP
       address.	This value is not precise and should not be used to identify a
       particular address or household.

       This attribute is returned by all end points and	location databases
       except Country.

   $location_rec->metro-code()
       This returns the	metro code of the location if the location is in the
       US.  MaxMind returns the	same metro codes as the	Google AdWords API
       (<https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions>).

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

   $location_rec->population_density()
       Returns a non-negative integer representing the estimated population
       per square kilometer associated with the	requested IP address.

       This attribute is only available	from the Insights end point and	the
       GeoIP2 Enterprise database.

   $location_rec->time_zone()
       This returns the	time zone associated with a location, as specified by
       the IANA	Time Zone Database (<http://www.iana.org/time-zones>), e.g.,
       "America/New_York".

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

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

AUTHORS
       o   Dave	Rolsky <drolsky@maxmind.com>

       o   Greg	Oschwald <goschwald@maxmind.com>

       o   Mark	Fowler <mfowler@maxmind.com>

       o   Olaf	Alders <oalders@maxmind.com>

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2013 - 2017 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.

perl v5.24.1			  2017-05-08	   GeoIP2::Record::Location(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | METHODS | SUPPORT | AUTHORS | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=GeoIP2::Record::Location&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help