Page MenuHomePhabricator

Figure out which data we can display in IP Info [4H]
Closed, ResolvedPublicOct 20 2020

Description

Goal

We want to know what information is available from the Maxmind database to display about an IP address. This will help us determine the design for the feature.

This task is to document all data available to us from Maxmind. Tentative table below, feel free to modify as you see fit.

CategoryData pointDefinition/Explanation
CityCity-level data associated with an IP address. This record is returned by all location services and databases besides Country.
confidenceA value from 0-100 indicating MaxMind's confidence that the city is correct. This attribute is only available from the Insights service and the GeoIP2 Enterprise database.
geonameIdThe GeoName ID for the city. This attribute is returned by all location services and databases.
nameThe name of the city based on the locales list. This attribute is returned by all location services and databases.
namesA array map where the keys are locale codes and the values are names. This attribute is returned by all location services and databases.
ContinentContains data for the continent record associated with an IP address. This record is returned by all location services and databases.
codeA two character continent code like "NA" (North America) or "OC" (Oceania). This attribute is returned by all location services and databases.
geonameIdThe GeoName ID for the continent. This attribute is returned by all location services and databases.
nameReturns the name of the continent based on the locales list. This attribute is returned by all location services and databases.
namesAn array map where the keys are locale codes and the values are names. This attribute is returned by all location services and databases.
CountryContains data for the country record associated with an IP address. This record is returned by all location services and databases.
confidenceA value from 0-100 indicating MaxMind's confidence that the country is correct. This attribute is only available from the Insights service and the GeoIP2 Enterprise database.
geonameIdThe GeoName ID for the country. This attribute is returned by all location services and databases.
isInEuropeanUnionThis is true if the country is a member state of the European Union. This attribute is returned by all location services and databases.
isoCodeThe ISO 3166-1 alpha-2 code for the country. This attribute is returned by all location services and databases.
nameThe name of the country based on the locales list. This attribute is returned by all location services and databases.
namesAn array map where the keys are locale codes and the values are names. This attribute is returned by all location services and databases.
LocationContains data for the location record associated with an IP address. This record is returned by all location services and databases besides Country.
averageIncomeThe average income in US dollars associated with the requested IP address. This attribute is only available from the Insights service.
accuracyRadiusThe 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.
latitudeThe 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.
longitudeThe 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.
populationDensityThe estimated population per square kilometer associated with the IP address. This attribute is only available from the Insights service.
metroCodeThe metro code of the location if the location is in the US. MaxMind returns the same metro codes as the Google AdWords API.
timeZoneThe time zone associated with location, as specified by the IANA Time Zone Database, e.g., "America/New_York".
MaxMindContains data about your account. This record is returned by all location services and databases.
queriesRemainingThe number of remaining queries you have for the service you are calling.
PostalContains data for the postal record associated with an IP address. This record is returned by all location databases and services besides Country.
codeThe postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code. This attribute is returned by all location databases and services besides Country.
confidenceA value from 0-100 indicating MaxMind's confidence that the postal code is correct. This attribute is only available from the Insights service and the GeoIP2 Enterprise
RepresentedCountryContains data for the represented country associated with an IP address. This class contains the country-level data associated with an IP address for the IP's represented country. The represented country is the country represented by something like a military base.
typeA string indicating the type of entity that is representing the country. Currently we only return military but this could expand to include other types in the future.
confidenceA value from 0-100 indicating MaxMind's confidence that the country is correct. This attribute is only available from the Insights service and the GeoIP2 Enterprise database.
geonameIdThe GeoName ID for the country. This attribute is returned by all location services and databases.
isInEuropeanUnionThis is true if the country is a member state of the European Union. This attribute is returned by all location services and databases.
isoCodeThe ISO 3166-1 alpha-2 code for the country. This attribute is returned by all location services and databases.
nameThe name of the country based on the locales list. This attribute is returned by all location services and databases.
namesAn array map where the keys are locale codes and the values are names. This attribute is returned by all location services and databases.
SubdivisionContains data for the subdivisions associated with an IP address. This record is returned by all location databases and services besides Country.
confidenceThis is a value from 0-100 indicating MaxMind's confidence that the subdivision is correct. This attribute is only available from the Insights service and the GeoIP2 Enterprise database.
geonameIdThis is a GeoName ID for the subdivision. This attribute is returned by all location databases and services besides Country.
isoCodeThis is a string up to three characters long contain the subdivision portion of the ISO 3166-2 code. This attribute is returned by all location databases and services except Country.
nameThe name of the subdivision based on the locales list. This attribute is returned by all location databases and services besides Country.
namesAn array map where the keys are locale codes and the values are names. This attribute is returned by all location databases and services besides Country.
TraitsContains data for the traits record associated with an IP address. This record is returned by all location services and databases.
autonomousSystemNumberThe autonomous system number associated with the IP address. This attribute is only available from the City and Insights web service and the GeoIP2 Enterprise database.
autonomousSystemOrganizationThe organization associated with the registered autonomous system number for the IP address. This attribute is only available from the City and Insights web service and the GeoIP2 Enterprise database.
connectionTypeThe connection type may take the following values: Dialup, Cable/DSL, Corporate, Cellular. Additional values may be added in the future. This attribute is only available in the GeoIP2 Enterprise database.
domainThe 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 and the GeoIP2 Enterprise database.
ipAddressThe 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.
isAnonymousThis is true if the IP address belongs to any sort of anonymous network. This property is only available from GeoIP2 Precision Insights.
isAnonymousProxyDeprecated. Please see our GeoIP2 Anonymous IP database to determine whether the IP address is used by an anonymizing service.
isAnonymousVpnThis is true if the IP address is registered to an anonymous VPN provider. If a VPN provider does not register subnets under names associated with them, we will likely only flag their IP ranges using the isHostingProvider property. This property is only available from GeoIP2 Precision Insights.
isHostingProviderThis is true if the IP address belongs to a hosting or VPN provider (see description of isAnonymousVpn property). This property is only available from GeoIP2 Precision Insights.
isLegitimateProxyThis attribute is 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.
isPublicProxyThis is true if the IP address belongs to a public proxy. This property is only available from GeoIP2 Precision Insights.
isResidentialProxyThis is true if the IP address is on a suspected anonymizing network and belongs to a residential ISP. This property is only available from GeoIP2 Precision Insights.
isSatelliteProviderDeprecated. 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.
isTorExitNodeThis is true if the IP address is a Tor exit node. This property is only available from GeoIP2 Precision Insights.
ispThe name of the ISP associated with the IP address. This attribute is only available from the City and Insights web services and the GeoIP2 Enterprise database.
networkThe network in CIDR notation associated with the record. In particular, this is the largest network where all of the fields besides ipAddress have the same value.
organizationThe name of the organization associated with the IP address. This attribute is only available from the City and Insights web services and the GeoIP2 Enterprise database.
staticIPScoreAn indicator of how static or dynamic an IP address is. This property is only available from GeoIP2 Precision Insights.
userCountThe estimated number of users sharing the IP/network during the past 24 hours. For IPv4, the count is for the individual IP. For IPv6, the count is for the /64 network. This property is only available from GeoIP2 Precision Insights.
userTypeThe 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 web service and the GeoIP2 Enterprise database.

Details

Due Date
Oct 20 2020, 4:00 AM

Event Timeline

Niharika triaged this task as Medium priority.Oct 7 2020, 6:44 AM
Niharika created this task.
Restricted Application added a subscriber: Aklapper. ยท View Herald TranscriptOct 7 2020, 6:44 AM
ARamirez_WMF renamed this task from Figure out which data we can display in IP Info to Figure out which data we can display in IP Info [4H].Oct 7 2020, 4:11 PM
ARamirez_WMF changed the subtype of this task from "Task" to "Deadline".Oct 8 2020, 10:14 PM
ARamirez_WMF set Due Date to Oct 20 2020, 4:00 AM.

@dbarratt While I was working on T264905 I noticed that there are around 50 data fields. I'm wondering if it's really worth copying them all out here?

They're documented in the Record classes if it helps: https://github.com/maxmind/GeoIP2-php/tree/master/src/Record

@dbarratt While I was working on T264905 I noticed that there are around 50 data fields. I'm wondering if it's really worth copying them all out here?

Oh thanks! yeah I can do the copy-pasting. :)

This is done. All fields are nullable (in other words, any field could be missing)