- Search: segment-aware autocomplete and location (nearby) search.
- Lookup: resolve a full postcode to graded address & building details.
- Assembly: assemble/disassemble and validate postcode structure.
Quickstart
Make your first request in under a minute.
Authentication
API keys, scopes and access levels.
Postcode format
How the 5 segments map to administrative areas.
Lookup levels
What data each access level returns (L1–L3).
Base URL
All requests go through the public API gateway:For local development against the stack, use
http://localhost:8081.Search and Lookup L1 are free. Lookup L2–L3 require an API key with the
lookup
scope and a sufficient access level, and consume credits.
