/osm/geocode/search

POST /api/osm/geocode/search

Price: 1 credit

Forward geocoding: resolve a free-text or structured address query to matching OpenStreetMap places

How to use it

Forward-geocode an address or place. Provide a free-text query, or structured fields (street/city/county/state/country/postalcode). Returns places with coordinates, structured address, category/type, bounding box, and extra tags. Restrict by country codes, viewbox, layer, or feature type.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Free-text place/address query (examples: "Eiffel Tower, Paris"; minLength: 1)
• amenity string nullable — Structured: name/type of a POI or amenity
• street string nullable — Structured: house number and street name
• city string nullable — Structured: city name
• county string nullable — Structured: county name
• state string nullable — Structured: state name
• country string nullable — Structured: country name
• postalcode string nullable — Structured: postal code
• count integer required — Max number of results (min: 1; max: 40)
• countrycodes string nullable — Comma-separated ISO 3166-1 alpha-2 country codes to restrict results (examples: "us,de")
• viewbox string nullable — Preferred area as 'lon1,lat1,lon2,lat2' to bias results toward (examples: "-0.5,51.3,0.3,51.7")
• bounded boolean — Restrict results strictly to the viewbox area (default: false)
• layer array nullable — Restrict results to one or more data layers (one of: "address", "poi", "railway", "natural", "manmade")
• featuretype string nullable — Restrict results to a feature type (one of: "country", "state", "city", "settlement")
• address_details boolean — Include a structured address breakdown (default: true)
• extra_tags boolean — Include additional OSM tags (website, phone, opening hours…) (default: true)
• name_details boolean — Include the full set of name/label variants (default: true)
• polygon_geojson boolean — Include the object geometry as a GeoJSON object (default: false)
• dedupe boolean — Remove near-duplicate results (default: true)
• exclude_place_ids string nullable — Comma-separated place ids to exclude from results
• accept_language string nullable — Preferred language(s) for names and labels (examples: "en", "de,en")

Response

• @type string (default: "OsmPlace")
• place_id integer nullable
• osm_type string nullable
• osm_id integer nullable
• latitude number nullable
• longitude number nullable
• category string nullable
• place_type string nullable
• place_rank integer nullable
• importance number nullable
• addresstype string nullable
• name string nullable
• display_name string nullable
• address object nullable
  • @type string (default: "OsmAddress")
  • house_number string nullable
  • road string nullable
  • quarter string nullable
  • neighbourhood string nullable
  • suburb string nullable
  • borough string nullable
  • city_district string nullable
  • city string nullable
  • municipality string nullable
  • county string nullable
  • state_district string nullable
  • state string nullable
  • region string nullable
  • postcode string nullable
  • country string nullable
  • country_code string nullable
  • iso3166_2 string nullable
• extratags object (default: {})
• namedetails object (default: {})
• boundingbox array (default: [])
• geojson object nullable
• source_url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.