What you get#
Onekey exposes OpenStreetMap as 3 endpoints behind one API key: 2 endpoints return one record (data is an object) and 1 endpoint return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for OpenStreetMap also works for the rest of the maps, weather & space category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
node | One OpenStreetMap node (position and tags) by id. | id* | 1 | stable |
note | One OpenStreetMap note by id. | id* | 1 | stable |
notes_in_area | OpenStreetMap notes (map bug reports) inside a bounding box. | bbox*, limit | 5 | stable |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls osm.node (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/osm/node?id=1" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from OpenStreetMap, with the same names as on every other platform. The count is how many of its 3 mapped endpoints return the field; a field the source lacks is null, never missing.
| Field | Type | Endpoints |
|---|---|---|
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 |
The full schema is in Unified schema.
Pricing#
OpenStreetMap calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.