.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "GeoIP2::Record::Traits 3pm" .TH GeoIP2::Record::Traits 3pm "2022-11-21" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" GeoIP2::Record::Traits \- Contains data for the traits record associated with an IP address .SH "VERSION" .IX Header "VERSION" version 2.006002 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use 5.008; \& \& use GeoIP2::WebService::Client; \& \& my $client = GeoIP2::WebService::Client\->new( \& account_id => 42, \& license_key => \*(Aqabcdef123456\*(Aq, \& ); \& \& my $insights = $client\->insights( ip => \*(Aq24.24.24.24\*(Aq ); \& \& my $traits_rec = $insights\->country(); \& print $traits_rec\->name(), "\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class contains the traits data associated with an \s-1IP\s0 address. .PP This record is returned by all the end points. .SH "METHODS" .IX Header "METHODS" This class provides the following methods: .ie n .SS "$traits_rec\->\fBautonomous_system_number()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBautonomous_system_number()\fP" .IX Subsection "$traits_rec->autonomous_system_number()" This returns the autonomous system number () associated with the \s-1IP\s0 address. .PP This attribute is only available from the City and Insights web service endpoints and the GeoIP2 Enterprise database. .ie n .SS "$traits_rec\->\fBautonomous_system_organization()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBautonomous_system_organization()\fP" .IX Subsection "$traits_rec->autonomous_system_organization()" This returns the organization associated with the registered autonomous system number () for the \s-1IP\s0 address. .PP This attribute is only available from the City and Insights web service endpoints and the GeoIP2 Enterprise database. .ie n .SS "$traits_rec\->\fBconnection_type()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBconnection_type()\fP" .IX Subsection "$traits_rec->connection_type()" This returns the connection type associated with the \s-1IP\s0 address. It may take the following values: \f(CW\*(C`Dialup\*(C'\fR, \f(CW\*(C`Cable/DSL\*(C'\fR, \f(CW\*(C`Corporate\*(C'\fR, or \f(CW\*(C`Cellular\*(C'\fR. Additional values may be added in the future. .PP This attribute is only available in the GeoIP2 Enterprise database. .ie n .SS "$traits_rec\->\fBdomain()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBdomain()\fP" .IX Subsection "$traits_rec->domain()" This returns the second level domain associated with the \s-1IP\s0 address. This will be something like \*(L"example.com\*(R" or \*(L"example.co.uk\*(R", not \*(L"foo.example.com\*(R". .PP This attribute is only available from the City and Insights web service endpoints and the GeoIP2 Enterprise database. .ie n .SS "$traits_rec\->\fBip_address()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBip_address()\fP" .IX Subsection "$traits_rec->ip_address()" This returns the \s-1IP\s0 address that the data in the model is for. If you performed a \*(L"me\*(R" lookup against the web service, this will be the externally routable \s-1IP\s0 address for the system the code is running on. If the system is behind a \s-1NAT,\s0 this may differ from the \s-1IP\s0 address locally assigned to it. .PP This attribute is returned by all end points. .ie n .SS "$traits_rec\->\fBis_anonymous()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBis_anonymous()\fP" .IX Subsection "$traits_rec->is_anonymous()" This returns a true value if the \s-1IP\s0 address belongs to any sort of anonymous network and a false value otherwise. .PP This attribute is only available from the Insights web service. .ie n .SS "$traits_rec\->\fBis_anonymous_proxy()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBis_anonymous_proxy()\fP" .IX Subsection "$traits_rec->is_anonymous_proxy()" \&\fIDeprecated.\fR Please see our GeoIP2 Anonymous \s-1IP\s0 database or our GeoIP2 Precision Insights service to determine whether the \s-1IP\s0 address is used by an anonymizing service. .PP This attribute is returned by all end points. .ie n .SS "$traits_rec\->\fBis_anonymous_vpn()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBis_anonymous_vpn()\fP" .IX Subsection "$traits_rec->is_anonymous_vpn()" This returns a true value if the \s-1IP\s0 address is registered to an anonymous \s-1VPN\s0 provider and a false value otherwise. .PP If a \s-1VPN\s0 provider does not register subnets under names associated with them, we will likely only flag their \s-1IP\s0 ranges using the \f(CW\*(C`is_hosting_provider\*(C'\fR attribute. .PP This attribute is only available from the Insights web service. .ie n .SS "$traits_rec\->\fBis_hosting_provider()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBis_hosting_provider()\fP" .IX Subsection "$traits_rec->is_hosting_provider()" This returns a true value if the \s-1IP\s0 address belongs to a hosting or \s-1VPN\s0 provider and a false value otherwise (see description of \f(CW\*(C`is_anonymous_vpn\*(C'\fR attribute). .PP This attribute is only available from the Insights web service. .ie n .SS "$traits_rec\->\fBis_legitimate_proxy()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBis_legitimate_proxy()\fP" .IX Subsection "$traits_rec->is_legitimate_proxy()" This attribute returns true if MaxMind believes this \s-1IP\s0 address to be a legitimate proxy, such as an internal \s-1VPN\s0 used by a corporation .PP This attribute is only available in the GeoIP2 Enterprise database. .ie n .SS "$traits_rec\->\fBis_public_proxy()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBis_public_proxy()\fP" .IX Subsection "$traits_rec->is_public_proxy()" This returns a true value if the \s-1IP\s0 address belongs to a public proxy and a false value otherwise. .PP This attribute is only available from the Insights web service. .ie n .SS "$traits_rec\->\fBis_satellite_provider()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBis_satellite_provider()\fP" .IX Subsection "$traits_rec->is_satellite_provider()" \&\fIDeprecated.\fR 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. .PP This attribute is returned by all end points. .ie n .SS "$traits_rec\->\fBis_tor_exit_node()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBis_tor_exit_node()\fP" .IX Subsection "$traits_rec->is_tor_exit_node()" This returns a true value if the \s-1IP\s0 address is a Tor exit node and a false value otherwise. .PP This attribute is only available from the Insights web service. .ie n .SS "$traits_rec\->\fBisp()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBisp()\fP" .IX Subsection "$traits_rec->isp()" This returns the name of the \s-1ISP\s0 associated with the \s-1IP\s0 address. .PP This attribute is only available from the City and Insights web service endpoints and the GeoIP2 Enterprise database. .ie n .SS "$traits_rec\->\fBorganization()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBorganization()\fP" .IX Subsection "$traits_rec->organization()" This returns the name of the organization associated with the \s-1IP\s0 address. .PP This attribute is only available from the City and Insights web service endpoints and the GeoIP2 Enterprise database. .ie n .SS "$traits_rec\->\fBuser_type()\fP" .el .SS "\f(CW$traits_rec\fP\->\fBuser_type()\fP" .IX Subsection "$traits_rec->user_type()" This returns the user type associated with the \s-1IP\s0 address. This can be one of the following values: .IP "\(bu" 4 business .IP "\(bu" 4 cafe .IP "\(bu" 4 cellular .IP "\(bu" 4 college .IP "\(bu" 4 content_delivery_network .IP "\(bu" 4 dialup .IP "\(bu" 4 government .IP "\(bu" 4 hosting .IP "\(bu" 4 library .IP "\(bu" 4 military .IP "\(bu" 4 residential .IP "\(bu" 4 router .IP "\(bu" 4 school .IP "\(bu" 4 search_engine_spider .IP "\(bu" 4 traveler .PP This attribute is only available from the Insights end point and the GeoIP2 Enterprise database. .SH "SUPPORT" .IX Header "SUPPORT" Bugs may be submitted through . .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Dave Rolsky .IP "\(bu" 4 Greg Oschwald .IP "\(bu" 4 Mark Fowler .IP "\(bu" 4 Olaf Alders .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2013 \- 2019 by MaxMind, Inc. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.