---
title: "Geocode Address"
method: GET
path: "/geocode-address"
tags: ["Geolocation"]
---

# Geocode Address

`GET /geocode-address`

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

## Query parameters

- `address` string
- `house-number` string
- `street` string
- `city` string
- `county` string
- `state` string
- `postal-code` string
- `country-code` string
- `language-code` string
- `fuzzy-search` boolean
- `country-codes` string
- `auto-complete` boolean
- `limit` integer

## Response `200`

OK

- GeocodeAddressResponse — Structure of geocode-address
  - `found` integer, required — The number of possible matching locations found
  - `locations` Location[], required — Array of matching location objects
    - `country` string, required — The country of the location
    - `address` string, required — The full address string using comma-separated values, use 'postal-address' for the address string formatted using country/region specific rules
    - `city` string, required — The city of the location
    - `country-code` string, required — The ISO 2-letter country code of the location
    - `country-code3` string, required — The ISO 3-letter country code of the location
    - `latitude` number, double, required — The location latitude
    - `postal-code` string, required — The postal code for the location
    - `longitude` number, double, required — The location longitude
    - `state` string, required — The state of the location
    - `address-structured` AddressStructured, required — Structure of address-structured
      - `name` string, required — The name of the person or organization
      - `number` string, required — The house or building number
      - `street` string, required — The name of the street/road
      - `area` string, required — The name of the local area. Also known as: suburb/neighborhood/locality/subdivision
      - `city` string, required — The name of the city/town/village
      - `county` string, required — The name of the county. Also known as: district/municipality/province
      - `state` string, required — The name of the state/region
      - `postal-code` string, required — The postal code
      - `country` string, required — The name of the country
    - `address-components` object, 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
    - `currency-code` string, required — ISO 4217 currency code associated with the country
    - `location-type` string, 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-tags` string[], 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
    - `timezone` Timezone, required — Structure of timezone
      - `id` string, required — The time zone ID as per the IANA time zone database (tzdata). If empty then no valid timezone was detected
      - `name` string, required — The full time zone name
      - `abbr` string, required — The time zone abbreviation
      - `date` string, required — The current date at the time zone (ISO 8601 format 'YYYY-MM-DD')
      - `time` string, required — The current time at the time zone (ISO 8601 format 'hh:mm:ss.sss')
      - `offset` string, required — The UTC offset for the time zone (ISO 8601 format '±hh:mm')
    - `region-code` string, required — The ISO 3166-2 region code for the location
    - `postal-address` string, required — The formatted address using local standards suitable for printing on an envelope
    - `language-code` string, required — The ISO 2-letter language code for the official language spoken in the country
    - `geohash` string, required — The location <a href="https://en.wikipedia.org/wiki/Geohash">geohash</a>
    - `continent-code` string, required — ISO 2-letter continent code
    - `building-type` string, 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-profile` object, 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

## Other responses

- `400` — Your API request has been rejected. Check error code for details
- `403` — You have failed to authenticate
- `500` — We messed up, sorry! Your request has caused a fatal exception
- `default` — We messed up, sorry! Your request has caused an error

---

[API](https://skmtc.net/neutrinoapi/apis/neutrino-api.md) · [All operations](https://skmtc.net/neutrinoapi/apis/neutrino-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/neutrinoapi/neutrino-api/versions/4ebd6b56de42/schema)