Reverse Geocoding

get

https://us1.locationiq.com/v1/reverse

Reverse geocoding is the process of converting a coordinate or location (latitude, longitude) to a readable address or place name. This permits the identification of nearby street addresses, places, and/or area subdivisions such as a neighborhood, county, state, or country.

Query Params

lat

float

required

Latitude of the location to generate an address for.

lon

float

required

Longitude of the location to generate an address for.

format

string

enum

Defaults to xml

Output Format. Defaults to xml.

This version (v1) of our Reverse Geocoding API is compatible with OpenStreetMap's Nominatim Geocoder in both JSON & XML formats. However, all our enhancements such as additional datasets and algorithms are supported only in json or xmlv1.1 format options.

Allowed:

zoom

integer

0 to 18

Defaults to 18

Level of detail required where 0 is country and 18 is house/building. Defaults to 18. In terms of address details the zoom levels are as follows:

zoom	address detail
3	country
5	state
8	county
10	city
14	suburb
16	street
18	building

accept-language

string

Defaults to en

Preferred language order for showing search results, overrides the value specified in the Accept-Language HTTP header. Defaults to en.

To use native language for the response when available, use accept-language=native.

Either uses standard rfc2616 accept-language string or a simple comma separated list of language codes.

addressdetails

integer

enum

Defaults to 1

Include a breakdown of the address of this result into elements. Important components include (but not limited to) country, postcode, state, county, city, town. Only those elements that are available for a given location will be returned.

Allowed:

normalizeaddress

integer

enum

Defaults to 0

Makes parsing of the address object easier by returning a predictable and defined list of elements. Defaults to 0 for backward compatibility. We recommend setting this to 1 for new projects.

Element Name	Description
name	House name or Point of Interest (POI) such as a Cafe or School
house_number	House or Building number
road	Roads, Highways, Freeways, Motorways
neighbourhood	Neighbourhoods, Allotments, Quarters, Communities
suburb	Suburbs, Subdivisions
island	Islands, Islets
city	Cities, Towns, Villages, Municipalities, Districts, Boroughs, Hamlets
county	Counties
state	States, Provinces, Regions, State Districts
state_code	State or Province Code
postcode	Postal Codes, Zipcodes
country	Countries, Nation-states
country_code	Country Code - 2 letter (ISO 3166-1 alpha-2)

Allowed:

normalizecity

integer

enum

Defaults to 0

For responses with no city value in the address section, the next available element in this order - city_district, locality, town, borough, municipality, village, hamlet, quarter, neighbourhood - from the address section will be normalized to city. Defaults to 0.

Allowed:

postaladdress

integer

enum

Defaults to 0

Returns address inside the postaladdress key, that is specifically formatted for each country. Currently supported for addresses in Belgium, Brazil, France, Germany, Greece, India, Ireland, Italy, Portugal, South Africa, Spain and United Kingdom. Defaults to 0.

Allowed:

oceans

integer

enum

Defaults to 0

Allows you to specify whether or not the API should return the name of an ocean or sea if the coordinates provided fall within a body of water. By default, this parameter is set to 0 for backward compatibility. When set to 1 and used in conjunction with addressdetails=1, the response will contain a limited address section consisting of only the name and water elements, providing the name of the ocean or sea the coordinates correspond to, if the coordinates fall within a body of water.

Allowed:

showdistance

integer

enum

Defaults to 0

Returns the straight line distance (meters) between the input location and the result's location. Value is set in the distance key of the response. Defaults to 0.

Allowed:

statecode

integer

enum

Defaults to 0

Adds state or province code when available to the state_code key inside the address object when available. Defaults to 0.

Allowed:

source

string

If this parameter is not specified, LocationIQ uses multiple public and proprietary datasets to return results. If you'd like to restrict results to only OpenStreetMap data, you can set the value of this parameter to nom. This will only query our internal cluster of Nominatim servers, and return results. We may still apply some post-processing steps to these results though, so results may vary from the official Nominatim instance.

namedetails

integer

enum

Defaults to 0

Include a list of alternative names in the results. These may include language variants, references, operator and brand. Defaults to 0.

Allowed:

extratags

integer

enum

Defaults to 0

Include additional information in the result if available, e.g. wikipedia link, opening hours. Defaults to 0.

Allowed:

polygon_geojson

integer

enum

Defaults to 0

Output geometry of results in geojson format. Defaults to 0.

Allowed:

polygon_kml

integer

enum

Defaults to 0

Output geometry of results in kml format. Defaults to 0.

Allowed:

polygon_svg

integer

enum

Defaults to 0

Output geometry of results in svg format. Defaults to 0.

Allowed:

polygon_text

integer

enum

Defaults to 0

Output geometry of results as a WKT. Defaults to 0.

Allowed:

polygon_threshold

number

Defaults to 0

When one of the polygon_* outputs is chosen, return a simplified version of the output geometry. The parameter describes the tolerance in degrees with which the geometry may differ from the original geometry. Topology is preserved in the geometry.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request

401Unauthorized

403The request has been made from an unauthorized domain.

404No location or places were found for the given input.

429Request exceeded the rate-limits set on your account.

500Internal Server Error