# Zippopotam on Onekey

> 1 endpoint for Zippopotam (1 stable, 0 beta), 1 credit 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/zippopotam
Reference (Markdown): https://onekey.dev/docs/api/zippopotam.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

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

- `entity.category` (string): 1
- `entity.description` (string): 1
- `entity.id` (string): 1
- `entity.name` (string): 1
- `place.lat` (number): 1
- `place.lon` (number): 1
- plus 1 platform-specific field under `ext.`

## Endpoints

### zippopotam.postcode

Place, state and coordinates for a postal code (60+ countries).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/zippopotam/postcode?country=us&code=90210` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `country` (string, required): ISO 3166-1 alpha-2, e.g. us
  - `code` (string, required): Postal code
- Fields returned: `entity.id`, `entity.name`, `entity.category`, `entity.description`, `place.lat`, `place.lon`, `ext.symbol`
- Reference: https://onekey.dev/docs/api/zippopotam/postcode.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/zippopotam/postcode?country=us&code=90210" \
  -H "x-api-key: YOUR_API_KEY"
```