Scroll to navigation

GeoIP2::Record::Traits(3pm) User Contributed Perl Documentation GeoIP2::Record::Traits(3pm)

NAME

GeoIP2::Record::Traits - Contains data for the traits record associated with an IP address

VERSION

version 2.006002

SYNOPSIS

  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 $traits_rec = $insights->country();
  print $traits_rec->name(), "\n";

DESCRIPTION

This class contains the traits data associated with an IP address.

This record is returned by all the end points.

METHODS

This class provides the following methods:

$traits_rec->autonomous_system_number()

This returns the autonomous system number (<http://en.wikipedia.org/wiki/Autonomous_system_(Internet)>) associated with the IP address.

This attribute is only available from the City and Insights web service endpoints and the GeoIP2 Enterprise database.

$traits_rec->autonomous_system_organization()

This returns the organization associated with the registered autonomous system number (<http://en.wikipedia.org/wiki/Autonomous_system_(Internet)>) for the IP address.

This attribute is only available from the City and Insights web service endpoints and the GeoIP2 Enterprise database.

$traits_rec->connection_type()

This returns the connection type associated with the IP address. It may take the following values: "Dialup", "Cable/DSL", "Corporate", or "Cellular". Additional values may be added in the future.

This attribute is only available in the GeoIP2 Enterprise database.

$traits_rec->domain()

This returns the second level domain associated with the IP address. This will be something like "example.com" or "example.co.uk", not "foo.example.com".

This attribute is only available from the City and Insights web service endpoints and the GeoIP2 Enterprise database.

$traits_rec->ip_address()

This returns the IP address that the data in the model is for. If you performed a "me" lookup against the web service, this will be the externally routable IP address for the system the code is running on. If the system is behind a NAT, this may differ from the IP address locally assigned to it.

This attribute is returned by all end points.

$traits_rec->is_anonymous()

This returns a true value if the IP address belongs to any sort of anonymous network and a false value otherwise.

This attribute is only available from the Insights web service.

$traits_rec->is_anonymous_proxy()

Deprecated. Please see our GeoIP2 Anonymous IP database <https://www.maxmind.com/en/geoip2-anonymous-ip-database> or our GeoIP2 Precision Insights service <https://www.maxmind.com/en/geoip2-precision-insights> to determine whether the IP address is used by an anonymizing service.

This attribute is returned by all end points.

$traits_rec->is_anonymous_vpn()

This returns a true value if the IP address is registered to an anonymous VPN provider and a false value otherwise.

If a VPN provider does not register subnets under names associated with them, we will likely only flag their IP ranges using the "is_hosting_provider" attribute.

This attribute is only available from the Insights web service.

$traits_rec->is_hosting_provider()

This returns a true value if the IP address belongs to a hosting or VPN provider and a false value otherwise (see description of "is_anonymous_vpn" attribute).

This attribute is only available from the Insights web service.

$traits_rec->is_legitimate_proxy()

This attribute returns true if MaxMind believes this IP address to be a legitimate proxy, such as an internal VPN used by a corporation

This attribute is only available in the GeoIP2 Enterprise database.

$traits_rec->is_public_proxy()

This returns a true value if the IP address belongs to a public proxy and a false value otherwise.

This attribute is only available from the Insights web service.

$traits_rec->is_satellite_provider()

Deprecated. Due to the increased coverage by mobile carriers, very few satellite providers now serve multiple countries. As a result, the output does not provide sufficiently relevant data for us to maintain it.

This attribute is returned by all end points.

$traits_rec->is_tor_exit_node()

This returns a true value if the IP address is a Tor exit node and a false value otherwise.

This attribute is only available from the Insights web service.

$traits_rec->isp()

This returns the name of the ISP associated with the IP address.

This attribute is only available from the City and Insights web service endpoints and the GeoIP2 Enterprise database.

$traits_rec->organization()

This returns the name of the organization associated with the IP address.

This attribute is only available from the City and Insights web service endpoints and the GeoIP2 Enterprise database.

$traits_rec->user_type()

This returns the user type associated with the IP address. This can be one of the following values:
  • business
  • cafe
  • cellular
  • college
  • content_delivery_network
  • dialup
  • government
  • hosting
  • library
  • military
  • residential
  • router
  • school
  • search_engine_spider
  • traveler

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

SUPPORT

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>

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.

2019-07-26 perl v5.28.1