| Module | Services | Data types | Constants |
|---|---|---|---|
| geo | GeoLocation GeoPoint IpAddress |
| Key | Field | Type | Description | Requiredness | Default value |
|---|---|---|---|---|---|
| 1 | xForwardedForHeader | string | The full value of the X-Forwarded-For header supplied. Normally you'll want to ignore this and use the ip field below. This is here just in case there's a bug in our logic of decoding the XFF header, or we can gain more information from the rest of the header. | required | |
| 2 | ip | string | The ip address of the client | optional |
| Key | Field | Type | Description | Requiredness | Default value |
|---|---|---|---|---|---|
| 1 | lat | double | Latitude | required | |
| 2 | lon | double | Longitude | required |
A geographical location
| Key | Field | Type | Description | Requiredness | Default value |
|---|---|---|---|---|---|
| 3 | geo | GeoPoint | The resolved geolocation of the ip address | optional | |
| 4 | countryCode | string | The two letter country code of the ip address; Note that guardian internal traffic (within the Guardian offices) is assigned a country code of "GNM" | optional | |
| 5 | countryName | string | Human readable country name | optional | |
| 6 | city | string | Human readable city name | optional | |
| 9 | metroCode | i32 | The metro code of the location if the location is in the US. | optional | |
| 7 | continent | string | Human readable continent name | optional | |
| 8 | subdivisions | list< | Administrative subdivisions, e.g. "Wales", "Berkshire" or "Alaska" | optional | |
| 10 | timezone | string | Time zone as specified by http://www.iana.org/time-zones e.g. America/New_York | optional |
Where this request was made from, derived by ip address lookup.