v1

latestSwagger 2.02026-07-132830204.5 KB

Geolocation

Geocode Address

Geocode an address, partial address or just the name of a place

get/geocode-address

Query parameters

addressstring

The full address, partial address or name of a place to try and locate. Comma separated address components are preferred.

house-numberstring

The house/building number to locate (for structured address searches)

streetstring

The street/road name to locate (for structured address searches)

citystring

The city/town name to locate (for structured address searches)

countystring

The county/region name to locate (for structured address searches)

statestring

The state name to locate (for structured address searches)

postal-codestring

The postal code to locate (for structured address searches)

country-codestring

Prefer results from this country code (the default is no country bias)

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>

fuzzy-searchboolean

If no matches are found for the given address, start performing a recursive fuzzy search until a geolocation is found. This option is useful for processing user supplied input that may be incomplete or have typos and where you do not mind some potential loss in precision

country-codesstring

Prefer results from this list of country codes (space or comma separated values). Preference is in the order supplied, you can use the 'country-code' parameter to also set a dynamic or user supplied country code which takes precedence

auto-completeboolean

Enable auto-complete for search-as-you-type and search suggestions. This option can find addresses based on partial search terms, combine with 'country-code' for country specific searches. Auto-complete works best with 'fuzzy-search' disabled for the fastest response times but can be combined if required

limitinteger

Limit search results to this many locations (between 1 and a maximum of 32)

Response

foundinteger required

The number of possible matching locations found

Example response

{
  "found": 1,
  "locations": [
    {
      "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",
      "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:02.561760836"
      }
    }
  ]
}