# Mapbase

> Mapbase turns coordinates into official locations, custom zones, hierarchy, geometry, and SEO-ready location context via a public HTTP API and TypeScript SDK.

- Stable API routes live under `/v1` on `https://api.mapbase.dev` and require an `x-api-key` header.
- Registry data spans four layers: `locations`, `postcodes`, `lau`, and `zones`.
- Canonical registry ids are prefixed `mb_loc_`, `mb_zon_`, `mb_lau_`, and `mb_cod_`.
- Quota is metered in credits; each operation documents its cost via the `x-mapbase-credits` OpenAPI extension.

## Docs

- [API reference (Markdown)](https://mapbase.dev/api-reference.md): Full OpenAPI-generated Markdown for every engine route, schema, and example
- [OpenAPI 3.1 spec](https://mapbase.dev/openapi.json): Machine-readable contract used to codegen the `mapbase` npm SDK
- [Interactive API reference](https://mapbase.dev/api-reference): Scalar UI with try-it-out against live endpoints
- [SDK guide](https://mapbase.dev/sdk): TypeScript SDK walkthroughs for autocomplete, point resolve, boundaries, and rate limits

## Optional

- [Playground](https://mapbase.dev/playground): Interactive map to explore autocomplete, resolve, and boundaries
- [Pricing](https://mapbase.dev/pricing): Plans, quotas, and rate limits
- [Data coverage](https://mapbase.dev/data): Countries and registry layer counts
- [npm package mapbase](https://www.npmjs.com/package/mapbase): Official TypeScript SDK