# OpenStreetMap on Onekey

> 3 endpoints for OpenStreetMap (3 stable, 0 beta), 1 to 5 credits each. Category: Maps, weather & space. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/osm
Reference (Markdown): https://onekey.dev/docs/api/osm.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 3 mapped OpenStreetMap endpoints return each:

- `entity.date` (ISO 8601 date): 3
- `entity.id` (string): 3
- `entity.url` (URL): 3
- `place.lat` (number): 3
- `place.lon` (number): 3
- `entity.category` (string): 2
- `entity.description` (string): 1
- `entity.name` (string): 1
- `package.version` (string): 1

## Endpoints

### osm.node

One OpenStreetMap node (position and tags) by id.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/osm/node?id=1` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Node id
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `place.lat`, `place.lon`, `entity.date`, `package.version`, `entity.url`
- Reference: https://onekey.dev/docs/api/osm/node.md

### osm.note

One OpenStreetMap note by id.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/osm/note?id=5544347` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Note id
- Fields returned: `entity.id`, `entity.category`, `entity.date`, `entity.url`, `place.lat`, `place.lon`
- Reference: https://onekey.dev/docs/api/osm/note.md

### osm.notes_in_area

OpenStreetMap notes (map bug reports) inside a bounding box.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/osm/notes_in_area?bbox=13.3%2C52.4%2C13.5%2C52.6&limit=5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `bbox` (string, required): Bounding box min_lon,min_lat,max_lon,max_lat (max 25 sq deg)
  - `limit` (string, optional, default 20): Rows (1-100)
- Fields returned: `entity.id`, `entity.category`, `entity.date`, `entity.url`, `place.lat`, `place.lon`
- Reference: https://onekey.dev/docs/api/osm/notes_in_area.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/osm/node?id=1" \
  -H "x-api-key: YOUR_API_KEY"
```