/osm/places/search

POST /api/osm/places/search

Price: 1 credit

Search OpenStreetMap POIs (nodes/ways/relations) by tag within a bounding box or radius (Overpass)

How to use it

Find OpenStreetMap points of interest by tag inside an area. Provide a tag_key (e.g. amenity) and optional tag_value (e.g. cafe), plus an area — either a bbox 'south,west,north,east' or lat+lon+radius_m. Returns matching nodes/ways/relations with coordinates, name, and full OSM tags.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 60; min: 20; max: 180)
• tag_key string required — OSM tag key to match, e.g. amenity, shop, tourism, leisure, office, healthcare, historic (examples: "amenity", "shop", "tourism"; minLength: 1)
• tag_value string nullable — OSM tag value to match (omit to match any object having the key). Popular amenity values: cafe, restaurant, bar, fast_food, pharmacy, hospital, bank, atm, fuel, parking, school, place_of_worship (examples: "cafe", "restaurant", "pharmacy")
• bbox string nullable — Bounding box as 'south,west,north,east' (decimal degrees) (examples: "48.85,2.29,48.87,2.31")
• lat number nullable — Center latitude for a radius search (min: -90; max: 90)
• lon number nullable — Center longitude for a radius search (min: -180; max: 180)
• radius_m integer nullable — Search radius in meters around the center point (min: 1; max: 50000)
• element_types array — Which OSM element types to search (default: ["node","way","relation"]; one of: "node", "way", "relation")
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "OsmPoi")
• element_type string required
• id integer required
• latitude number nullable
• longitude number nullable
• name string nullable
• tags object (default: {})
• 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.