osm.notes_in_area

stable Advanced

OpenStreetMap notes (map bug reports) inside a bounding box.

GET /v1/osm/notes_in_area

What you get#

A list of Osm 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
`bbox`	string	yes	(required)	Bounding box min_lon,min_lat,max_lon,max_lat (max 25 sq deg)	max 60 chars; must match `-?\d{1,3}(?:\.\d{1,6})?(?:,-?\d{1,3}(?:\.\d{1,6})?){3}`; trimmed
`limit`	string	no	`20`	Rows (1-100)	max 3 chars; must match `[1-9]\d?\|100`; trimmed

Request#

curl "https://api.onekey.dev/v1/osm/notes_in_area?bbox=13.3%2C52.4%2C13.5%2C52.6&limit=5" \
  -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 Osm response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "5544347",
        "category": "open",
        "date": "2026-09-28 18:23:14 UTC",
        "url": "https://api.openstreetmap.org/api/0.6/notes/5544347.json"
      },
      "place": {
        "lat": 52.5051531,
        "lon": 13.3338148
      }
    },
    {
      "entity": {
        "id": "5236006",
        "category": "open",
        "date": "2026-04-05 16:23:11 UTC",
        "url": "https://api.openstreetmap.org/api/0.6/notes/5236006.json"
      },
      "place": {
        "lat": 52.4398628,
        "lon": 13.4260323
      }
    }
  ],
  "metadata": {
    "platform": "osm",
    "endpoint": "notes_in_area",
    "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
`properties.id`	`entity.id`	`toString`
`properties.status`	`entity.category`	-
`properties.date_created`	`entity.date`	-
`properties.url`	`entity.url`	`safeUrl`
`geometry.coordinates.1`	`place.lat`	`toNumber`
`geometry.coordinates.0`	`place.lon`	`toNumber`

Caching and freshness#

Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
Between 30 seconds and 5 minutes the cached copy is still served instantly and marked stale: true while 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: stable (verified against the live source).