What you get#
Onekey exposes Nominatim as 3 endpoints behind one API key: 1 endpoint return one record (data is an object) and 2 endpoints 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 Nominatim also works for the rest of the maps, weather & space category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
lookup | Look up OSM objects by id (e.g. R62422, N123, W456). | osm_ids* | 5 | beta |
reverse | Reverse geocoding of a coordinate to the nearest address. | lat*, lon*, zoom | 1 | beta |
search | Forward geocoding of a free-text place/address. | q*, limit | 5 | beta |
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 nominatim.reverse (1 credit, beta). 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/nominatim/reverse?lat=52.52&lon=13.41" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Nominatim, 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. 3 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
entity.category | string | 3 |
entity.description | string | 3 |
entity.id | string | 3 |
entity.name | string | 3 |
place.lat | number | 3 |
place.lon | number | 3 |
The full schema is in Unified schema.
Pricing#
Nominatim 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.