v1
latestOpenAPI 3.0.02026-07-241437122.4 KBLookup
The lookup API allows querying the address and other details of one or multiple OSM objects, such as nodes, ways, or relations.
Query parameters
This must contain a comma-separated list of OSM ids each prefixed with its type, one of node(N), way(W) or relation(R). Up to 3 ids can be queried at the same time.
Wrap json output in a callback function (JSONP) i.e. <string>(<json>). Only has an effect for JSON output formats.
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.
Include additional information in the result if available, e.g. wikipedia link, opening hours. Defaults to 0.
Include a list of alternative names in the results. These may include language variants, references, operator and brand. Defaults to 0.
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 <a href="https://tools.ietf.org/html/rfc2616#section-14.4" target="_blank">rfc2616 accept-language string</a> or a simple comma separated list of language codes.
Output geometry of results in geojson format. Defaults to 0.
Output geometry of results in kml format. Defaults to 0.
Output geometry of results in svg format. Defaults to 0.
Output geometry of results as a WKT. 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.
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) |
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.
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.
Adds state or province code when available to the state_code key inside the address object when available. Defaults to 0.
Output Format. Only json supported as of now.
Response
OK
Example response
{
"address": {
"house_number": "3894",
"road": "Spring Mill Way",
"residential": "Hunter’s Point",
"village": "Landen",
"city": "Landen",
"county": "Warren County",
"state": "Ohio",
"postcode": "45039",
"country": "United States of America",
"country_code": "us",
"state_code": "oh"
}
}