Documentation menu
Endpoints
Every endpoint, grouped by what it’s for.
Pick an endpoint to see its parameters, responses and an example request.
Places
- GET
/place/suggestionTypeahead - POST
/place/batchThe same answer for up to 500 locations - GET
/place/batch/{batch}What each location in a batch resolved to - PATCH
/place/batch/{batch}/item/{ref}Override one match in a batch - GET
/placeWhat is at a location, who governs it, and the rules there - POST
/place/proposalWould this proposal be allowed - GET
/parcelFind parcels - GET
/parcel/{parcel}One parcel
Property records
Jurisdictions
Zoning
Activity
Evidence
- GET
/citation/{citation}The passage itself - GET
/citation/{citation}/sourceThe retained page the passage was read from - POST
/citation/{citation}/correctionDispute what we read in this passage - GET
/citation/{citation}/correction/{correction}Where a correction stands - GET
/answer/{answer}Replay an answer - GET
/coverageWhat we cover, per jurisdiction per layer, including what we do not
Changes
- GET
/change_eventWhat changed, cited on both sides - GET
/change_event/{change_event}One change - GET
/monitorYour monitors - POST
/monitorMonitor for changes - GET
/monitor/{monitor}One monitor - PATCH
/monitor/{monitor}Change a monitor - DELETE
/monitor/{monitor}Stop a monitor - GET
/monitor/{monitor}/change_eventWhat a monitor has matched - GET
/webhookYour webhooks - POST
/webhookAdd a delivery endpoint - GET
/webhook/{webhook}One webhook - PATCH
/webhook/{webhook}Change a webhook - DELETE
/webhook/{webhook}Remove a webhook - GET
/webhook/{webhook}/deliveryThe delivery log - POST
/webhook/{webhook}/deliverySend a signed test delivery
Exports and maps
- GET
/extractYour extracts - POST
/extractStart a bulk extract - GET
/extract/{extract}One extract, and its files - GET
/mapThe map layers we hold, with their dates - GET
/map/{layer}TileJSON for a layer - GET
/map/{layer}/{z}/{x}/{y}One vector tile - GET
/map/{layer}/imageA stamped map image, usable as an exhibit - GET
/map/ogcOGC landing page - GET
/map/ogc/conformanceOGC conformance declaration - GET
/map/ogc/collectionsOGC collections - GET
/map/ogc/collections/{collectionId}One OGC collection - GET
/map/ogc/collections/{collectionId}/itemsFeatures - GET
/map/ogc/collections/{collectionId}/items/{featureId}One feature