1GeoIP2(3)             User Contributed Perl Documentation            GeoIP2(3)
2
3
4

NAME

6       GeoIP2 - Perl API for MaxMind's GeoIP2 web services and databases
7

VERSION

9       version 2.006002
10

DESCRIPTION

12       This distribution provides an API for the GeoIP2 web services
13       <http://dev.maxmind.com/geoip/geoip2/web-services> and databases
14       <http://dev.maxmind.com/geoip/geoip2/downloadable>. The API also works
15       with the free GeoLite2 databases
16       <http://dev.maxmind.com/geoip/geoip2/geolite2/>.
17
18       See GeoIP2::WebService::Client for details on the web service client
19       API and GeoIP2::Database::Reader for the database API.
20

SPEEDING UP DATABASE READING

22       This module only depends on the pure Perl implementation of the MaxMind
23       database reader (MaxMind::DB::Reader). If you install the libmaxminddb
24       library (<http://maxmind.github.io/libmaxminddb/>) and
25       MaxMind::DB::Reader::XS, then the XS implementation will be loaded
26       automatically. The XS implementation is approximately 100x faster than
27       the pure Perl implementation.
28

VALUES TO USE FOR DATABASE OR HASH KEYS

30       We strongly discourage you from using a value from any "names" accessor
31       as a key in a database or hash.
32
33       These names may change between releases. Instead we recommend using one
34       of the following:
35
36       •   GeoIP2::Record::City - "$city->geoname_id"
37
38       •   GeoIP2::Record::Continent - "$continent->code" or
39           "$continent->geoname_id"
40
41       •   GeoIP2::Record::Country and GeoIP2::Record::RepresentedCountry -
42           "$country->iso_code" or "$country->geoname_id"
43
44       •   GeoIP2::Record::Subdivision - "$subdivision->iso_code" or
45           "$subdivision->geoname_id"
46

INTEGRATION WITH GEONAMES

48       GeoNames (<http://www.geonames.org/>) offers web services and
49       downloadable databases with data on geographical features around the
50       world, including populated places. They offer both free and paid
51       premium data. Each feature is uniquely identified by a "geoname_id",
52       which is an integer.
53
54       Many of the records returned by the GeoIP web services and databases
55       include a "geoname_id" field. This is the ID of a geographical feature
56       (city, region, country, etc.) in the GeoNames database.
57
58       Some of the data that MaxMind provides is also sourced from GeoNames.
59       We source data such as place names, ISO codes, and other similar data
60       from the GeoNames premium data set.
61

REPORTING DATA PROBLEMS

63       If the problem you find is that an IP address is incorrectly mapped,
64       please submit your correction to MaxMind at
65       <http://www.maxmind.com/en/correction>.
66
67       If you find some other sort of mistake, like an incorrect spelling,
68       please check the GeoNames site (<http://www.geonames.org/>) first. Once
69       you've searched for a place and found it on the GeoNames map view,
70       there are a number of links you can use to correct data ("move",
71       "edit", "alternate names", etc.). Once the correction is part of the
72       GeoNames data set, it will be automatically incorporated into future
73       MaxMind releases.
74
75       If you are a paying MaxMind customer and you're not sure where to
76       submit a correction, please contact MaxMind support at for help. See
77       <http://www.maxmind.com/en/support> for support details.
78

VERSIONING POLICY

80       This module uses semantic versioning as described by
81       <http://semver.org/>. Version numbers can be read as X.YYYZZZ, where X
82       is the major number, YYY is the minor number, and ZZZ is the patch
83       number.
84

PERL VERSION SUPPORT

86       This API supports Perl 5.10 and above.
87
88       The data returned from the GeoIP2 web services includes Unicode
89       characters in several locales. This may expose bugs in earlier versions
90       of Perl. If Unicode support is important to you, we recommend that you
91       use the most recent version of Perl available.
92

SUPPORT

94       This module is deprecated and will only receive fixes for major bugs
95       and security vulnerabilities. New features and functionality will not
96       be added.
97
98       Please report all issues with this code using the GitHub issue tracker
99       at <https://github.com/maxmind/GeoIP2-perl/issues>.
100
101       If you are having an issue with a MaxMind service that is not specific
102       to the client API please see <http://www.maxmind.com/en/support> for
103       details.
104
105       Bugs may be submitted through
106       <https://github.com/maxmind/GeoIP2-perl/issues>.
107

AUTHORS

109       •   Dave Rolsky <drolsky@maxmind.com>
110
111       •   Greg Oschwald <goschwald@maxmind.com>
112
113       •   Mark Fowler <mfowler@maxmind.com>
114
115       •   Olaf Alders <oalders@maxmind.com>
116

CONTRIBUTORS

118       •   Adam Lapczynski <alapczynski@maxmind.com>
119
120       •   Andy Jack <github@veracity.ca>
121
122       •   E. Choroba <choroba@matfyz.cz>
123
124       •   Florian Ragwitz <rafl@debian.org>
125
126       •   Graham Knop <haarg@haarg.org>
127
128       •   Mateu X Hunter <mhunter@maxmind.com>
129
130       •   Michael F. Canzoneri <mikecanzoneri@gmail.com>
131
132       •   Narsimham Chelluri <nchelluri@maxmind.com>
133
134       •   Narsimham Chelluri <nchelluri@users.noreply.github.com>
135
136       •   Patrick Cronin <PatrickCronin@users.noreply.github.com>
137
138       •   William Storey <wstorey@maxmind.com>
139

141       This software is copyright (c) 2013 - 2019 by MaxMind, Inc.
142
143       This is free software; you can redistribute it and/or modify it under
144       the same terms as the Perl 5 programming language system itself.
145
146
147
148perl v5.32.1                      2021-01-27                         GeoIP2(3)
Impressum