# Overpass on Onekey

> 2 endpoints for Overpass (0 stable, 2 beta), 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/overpass
Reference (Markdown): https://onekey.dev/docs/api/overpass.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

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

- `entity.category` (string): 2
- `entity.description` (string): 2
- `entity.id` (string): 2
- `entity.name` (string): 2
- `entity.url` (URL): 2
- `place.lat` (number): 2
- `place.lon` (number): 2
- plus 3 platform-specific fields under `ext.`

## Endpoints

### overpass.nearby_amenities

OSM amenities (cafe, restaurant, pharmacy, ...) within a radius of a point.
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/overpass/nearby_amenities?lat=52.52&lon=13.405&amenity=cafe` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `lat` (string, required): Latitude in decimal degrees (-90..90)
  - `lon` (string, required): Longitude in decimal degrees (-180..180)
  - `amenity` (string, required): OSM amenity value, e.g. cafe, pharmacy, atm
  - `radius` (string, optional, default 500): Radius in metres (1-5000)
  - `limit` (string, optional, default 20): Max results (1-100)
- Fields returned: `entity.id`, `entity.name`, `entity.category`, `entity.description`, `entity.url`, `place.lat`, `place.lon`, `ext.openingHours`, `ext.street`, `ext.city`
- Reference: https://onekey.dev/docs/api/overpass/nearby_amenities.md

### overpass.nearby_shops

OSM shops (supermarket, bakery, ...) within a radius of a point.
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/overpass/nearby_shops?lat=52.52&lon=13.405&shop=supermarket` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `lat` (string, required): Latitude in decimal degrees (-90..90)
  - `lon` (string, required): Longitude in decimal degrees (-180..180)
  - `shop` (string, required): OSM shop value, e.g. supermarket, bakery
  - `radius` (string, optional, default 500): Radius in metres (1-5000)
  - `limit` (string, optional, default 20): Max results (1-100)
- Fields returned: `entity.id`, `entity.name`, `entity.category`, `entity.description`, `entity.url`, `place.lat`, `place.lon`, `ext.openingHours`, `ext.street`, `ext.city`
- Reference: https://onekey.dev/docs/api/overpass/nearby_shops.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/overpass/nearby_amenities?lat=52.52&lon=13.405&amenity=cafe" \
  -H "x-api-key: YOUR_API_KEY"
```