overpass.nearby_amenities
beta Advanced
OSM amenities (cafe, restaurant, pharmacy, ...) within a radius of a point.
GET /v1/overpass/nearby_amenities
What you get#
A list of Overpass results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.
What it costs#
- Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
- Free when served from cache (0.2 credit for a cached response over 100 KB).
- Free if the request is invalid (never charged) or the source fails or reports not found (refunded).
Parameters#
| Name | Type | Required | Default | What it is | Constraints |
|---|---|---|---|---|---|
lat | string | yes | (required) | Latitude in decimal degrees (-90..90) | max 10 chars; must match -?(?:[0-8]?\d(?:\.\d{1,6})?|90(?:\.0{1,6})?); trimmed |
lon | string | yes | (required) | Longitude in decimal degrees (-180..180) | max 11 chars; must match -?(?:1[0-7]\d(?:\.\d{1,6})?|\d{1,2}(?:\.\d{1,6})?|180(?:\.0{1,6})?); trimmed |
amenity | string | yes | (required) | OSM amenity value, e.g. cafe, pharmacy, atm | max 30 chars; must match [a-z_]{2,30}; trimmed, lowercased |
radius | string | no | 500 | Radius in metres (1-5000) | max 4 chars; must match [1-9]\d{0,3}|5000; trimmed |
limit | string | no | 20 | Max results (1-100) | max 3 chars; must match [1-9]\d?|100; trimmed |
Request#
curl "https://api.onekey.dev/v1/overpass/nearby_amenities?lat=52.52&lon=13.405&amenity=cafe" \
-H "x-api-key: YOUR_API_KEY"Try it
Add your key to run this call right here. No key? Get one free. The key stays in this tab.
Recorded response#
A real Overpass response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.
{
"success": true,
"data": [
{
"entity": {
"id": "89274938",
"name": "Segafredo",
"category": "cafe",
"description": null,
"url": null
},
"ext": {
"openingHours": null,
"street": null,
"city": null
},
"place": {
"lat": 52.5194912,
"lon": 13.4102122
}
},
{
"entity": {
"id": "305260598",
"name": "Café im Alten Museum",
"category": "cafe",
"description": null,
"url": null
},
"ext": {
"openingHours": "PH,Tu-Su 10:00-18:00",
"street": null,
"city": null
},
"place": {
"lat": 52.5191167,
"lon": 13.3985266
}
}
],
"metadata": {
"platform": "overpass",
"endpoint": "nearby_amenities",
"cached": false,
"stale": false,
"age_s": 0,
"fetched_at": "2026-01-01T12:00:00+00:00",
"credits_charged": 5,
"request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
},
"error": null
}Field mapping#
How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.
| Source path | Onekey field | Transform |
|---|---|---|
id | entity.id | toString |
tags.name | entity.name | - |
tags.amenity | entity.category | - |
tags.shop | entity.description | - |
tags.website | entity.url | safeUrl |
tags.opening_hours | ext.openingHours | - |
lat | place.lat | toNumber |
lon | place.lon | toNumber |
tags.addr:street | ext.street | - |
tags.addr:city | ext.city | - |
Caching and freshness#
- Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
- Between 2 minutes and 15 minutes the cached copy is still served instantly and marked
stale: truewhile Onekey refreshes it in the background. - If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
- A "not found" is remembered for 1 minute and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.
What can go wrong#
| Status | Code | What to do |
|---|---|---|
| 401 | unauthorized | Check the x-api-key header. |
| 402 | insufficient_credits | Add credits; your balance must cover the price. |
| 404 | not_found | Unknown endpoint path. |
| 422 | invalid_params | Fix the parameters using the table above. Free. |
| 429 | rate_limited | Wait Retry-After seconds, then retry. |
| 502 | upstream_error | The source failed. Refunded; retry with backoff. |
See Errors for the full list and retry guidance.
Status: beta (not yet verified against the live source).