Documentation menu
geocoding
GET/geocode/retrieve
API key required, sent as Authorization: Bearer snk_… or ?api_key=snk_….
Call it
bash
curl -fsS -X GET "https://api.mapmap.ai/geocode/retrieve?id=…" \
-H "Authorization: Bearer $MAPMAP_KEY"Parameters
| Name | In | Required | Description |
|---|---|---|---|
| id | query | yes | A document id, exactly as GET /geocode/suggest or GET /geocode reported it. Matched verbatim (no folding, trimming or case change), so an edited id is a 404, never a near-miss served as though it were the real thing. Ids starting ukpc: are reserved for UK postcodes that GET /geocode/suggest lists without an index document: ukpc: then the postcode in capitals with no space (ukpc:BN147RY for a unit, ukpc:BN14 for a district). A district resolves to its centre; a unit resolves to the index document for that postcode when there is one, otherwise to the forward geocoder's position for it. Ids starting iepc: (an Eircode, or an Eircode routing area such as iepc:D02) and nlpc: (a Dutch postcode) work the same way, and an id starting photon: names an addressed OpenStreetMap element and where it stands (photon:n703432291@48.8554814,2.3604077), resolved from the forward geocoder |
Responses
200A Photon-compatible GeoJSON FeatureCollection carrying exactly one feature: the same shape, and the same property set, that
GET /geocode returns for this document400Missing or over-long
id401Missing or invalid API key
404No document carries that id: it was never issued, or the index has been rebuilt since it was. For a
ukpc:, iepc:, nlpc: or photon: id, no source knows that postcode or address any more. The body's detail says to search again and re-pick429Quota or rate limit exceeded
501This deployment has no first-party geocode index, or its index predates the document-id field (
urn:sn-gateway:problem:suggest-not-enabled). Reserved ukpc: postcode ids are resolved either way502A reserved id needed the forward geocoder and the request to it failed
Error bodies follow the shared problem model documented on API conventions.
Also under geocoding
Generated from https://api.mapmap.ai/openapi.json on 2026-11-01 · operationId get_geocode_retrieve