Sign in

v1

latestSwagger 2.02026-07-132830204.5 KB
Geolocation

Geocode Reverse

Convert a geographic coordinate (latitude and longitude) into a real world address

get/geocode-reverse

Query parameters

latitudestring

The location latitude in decimal degrees format

longitudestring

The location longitude in decimal degrees format

language-codestring

The language to display results in, available languages are: <ul> <li>ar, de, en, es, fr, it, ja, nl, pt, ru, zh</li> </ul>

zoomstring

The zoom level to respond with: <br> <ul> <li>address - the most precise address available</li> <li>street - the street level</li> <li>city - the city level</li> <li>state - the state level</li> <li>country - the country level</li> </ul>

geohashstring

Reverse lookup by a geohash instead of using latitude and longitude

Response

OK

countrystring required

The country of the location

foundboolean required

True if these coordinates map to a real location

addressstring required

The full address string using comma-separated values, use 'postal-address' for the address string formatted using country/region specific rules

citystring required

The city of the location

country-codestring required

The ISO 2-letter country code of the location

postal-codestring required

The postal code for the location

statestring required

The state of the location

address-componentsobject required

The components which make up the address such as road, city, state, etc. These are country/region specific values, use 'address-structured' for a strict address structure which is the same for all locations globally

country-code3string required

The ISO 3-letter country code of the location

currency-codestring required

ISO 4217 currency code associated with the country

location-typestring required

The detected location type ordered roughly from most to least precise, possible values are: <br> <ul> <li>address - indicates a precise street address</li> <li>street - accurate to the street level but may not point to the exact location of the house/building number</li> <li>city - accurate to the city level, this includes villages, towns, suburbs, etc</li> <li>postal-code - indicates a postal code area (no house or street information present)</li> <li>railway - location is part of a rail network such as a station or railway track</li> <li>natural - indicates a natural feature, for example a mountain peak or a waterway</li> <li>island - location is an island or archipelago</li> <li>administrative - indicates an administrative boundary such as a country, state or province</li> </ul>

location-tagsstring[] required

Array of strings containing any location tags associated with the address. Tags are additional pieces of metadata about a specific location, there are thousands of different tags. Some examples of tags: shop, office, cafe, bank, pub

latitudenumber double required

The location latitude

longitudenumber double required

The location longitude

region-codestring required

The ISO 3166-2 region code for the location

postal-addressstring required

The formatted address using local standards suitable for printing on an envelope

language-codestring required

The ISO 2-letter language code for the official language spoken in the country

geohashstring required

The location <a href="https://en.wikipedia.org/wiki/Geohash">geohash</a>

continent-codestring required

ISO 2-letter continent code

building-typestring required

The detected building type for the address, possible values are: <br> <ul> <li>none - no building type was detected for this location</li> <li>house - a residential house/property</li> <li>apartment - a residential apartment complex</li> <li>office - a commercial/business office</li> <li>accommodation - a hotel/motel or other type of accommodation</li> <li>education - a school or university</li> <li>food - a restaurant or place where food can be purchased</li> <li>shop - a shop selling any type of goods</li> <li>attraction - an attraction such as theme parks or tourist activities</li> <li>medical - a hospital or other medical facility</li> <li>transport - a transportation building such as a bus or train depot</li> <li>commercial - a commercial/industrial building</li> <li>government - a government or military facility</li> <li>public - a public building such as a townhall or community centre</li> </ul>

location-profileobject required

Map containing any external metadata linked to the location. Currently supports the following values which are only set if known: website-url, phone-number, org-name, wikipedia-title, wikidata-entity

Example response

{
  "address": "1 Molesworth Street, Pipitea, Wellington 6145, New Zealand",
  "address-components": {
    "city": "Wellington",
    "country": "New Zealand",
    "county": "Wellington City",
    "house-number": "1",
    "neighbourhood": "Lambton",
    "postal-code": "6145",
    "road": "Molesworth Street",
    "state": "Wellington",
    "suburb": "Pipitea"
  },
  "address-structured": {
    "area": "Pipitea",
    "city": "Wellington",
    "country": "New Zealand",
    "county": "Wellington City",
    "name": "",
    "number": "1",
    "postal-code": "6145",
    "state": "Wellington",
    "street": "Molesworth Street"
  },
  "building-type": "house",
  "city": "Wellington",
  "continent-code": "OC",
  "country": "New Zealand",
  "country-code": "NZ",
  "country-code3": "NZL",
  "currency-code": "NZD",
  "found": true,
  "geohash": "rbsm1jthekqy",
  "language-code": "en",
  "latitude": -41.277585,
  "location-profile": {},
  "location-tags": [
    "house"
  ],
  "location-type": "address",
  "longitude": 174.777523,
  "postal-address": "1 Molesworth Street\nPipitea\nWellington 6145\nNew Zealand",
  "postal-code": "6145",
  "region-code": "WGN",
  "state": "Wellington",
  "timezone": {
    "abbr": "NZDT",
    "date": "2025-11-18",
    "id": "Pacific/Auckland",
    "name": "New Zealand Daylight Time",
    "offset": "+13:00",
    "time": "17:05:01.96639137"
  }
}