{"info":{"name":"PlotFinder — Encumbrance API","description":"What restricts this property? Servitudes, leases, mineral rights, state-land status and proclamation areas that burden or touch a South African land parcel, intersected from the Chief Surveyor-General's cadastral spatial data.","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"encumbrances","item":[{"name":"Everything that restricts a parcel","request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiKey}}"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/parcel/{lpi}","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","parcel","{lpi}"],"query":[]},"description":"All encumbrances intersecting the parcel with this LPI: class, raw and normalised type, SG number, the intersecting geometry, overlap in m² and as a share of the parcel, and the relationship (crosses | within | contains | touches)."}},{"name":"Cheap screening summary for one parcel","request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiKey}}"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/summary/parcel/{lpi}","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","summary","parcel","{lpi}"],"query":[]},"description":"Boolean-ish screening at volume: does anything touch this parcel, how many per class, and the largest single overlap as a percentage of the parcel. Priced below the full /parcel endpoint."}},{"name":"Encumbrances at a point","request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiKey}}"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/at","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","at"],"query":[{"key":"latitude","value":"","description":"","disabled":true},{"key":"longitude","value":"","description":"","disabled":true},{"key":"radius_m","value":"","description":"","disabled":true}]},"description":"Encumbrances at a point"}},{"name":"Encumbrances in a bounding box","request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiKey}}"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/within","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","within"],"query":[{"key":"bbox","value":"","description":"minlon,minlat,maxlon,maxlat","disabled":false},{"key":"encumbrance_class","value":"","description":"","disabled":true},{"key":"limit","value":"","description":"","disabled":true},{"key":"cursor","value":"","description":"","disabled":true}]},"description":"Encumbrances in a bounding box"}},{"name":"Corridor screening","request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiKey}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/intersect","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","intersect"],"query":[]},"description":"POST a GeoJSON LineString or Polygon — a proposed fibre route, pipeline or road — and get every encumbrance and every affected parcel along it, with per-parcel overlap length or area. Lines up to 200 km; polygons up to 2,500 km².","body":{"mode":"raw","raw":"{}"}}},{"name":"Filter encumbrances by attribute","request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiKey}}"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/search","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","search"],"query":[{"key":"province","value":"","description":"","disabled":true},{"key":"encumbrance_class","value":"","description":"","disabled":true},{"key":"ease_type","value":"","description":"","disabled":true},{"key":"ease_type_normalised","value":"","description":"","disabled":true},{"key":"sg_number","value":"","description":"exact, or * as wildcard","disabled":true},{"key":"record_status","value":"","description":"","disabled":true},{"key":"bbox","value":"","description":"","disabled":true},{"key":"limit","value":"","description":"","disabled":true},{"key":"cursor","value":"","description":"","disabled":true}]},"description":"Filter encumbrances by attribute"}},{"name":"Screen up to 500 parcels in one call","request":{"method":"POST","header":[{"key":"X-API-KEY","value":"{{apiKey}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/batch","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","batch"],"query":[]},"description":"Items are {lpi} or {latitude, longitude}; results align positionally, null where no parcel was found.","body":{"mode":"raw","raw":"{}"}}},{"name":"What is loaded, per province and class","request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiKey}}"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/coverage","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","coverage"],"query":[]},"description":"What is loaded, per province and class"}},{"name":"Coverage-map data: density cells or class-keyed boundaries","request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiKey}}"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/heatmap","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","heatmap"],"query":[{"key":"north","value":"","description":"","disabled":true},{"key":"south","value":"","description":"","disabled":true},{"key":"east","value":"","description":"","disabled":true},{"key":"west","value":"","description":"","disabled":true},{"key":"view","value":"","description":"","disabled":true},{"key":"classes","value":"","description":"comma list; default all","disabled":true}]},"description":"Drives coverage maps, including the PlotFinder admin panel's Encumbrance layer. The server picks the answer from the viewport: density cells (whole multiples of 0.01°, busiest-first, capped at 4,000 with an explicit truncation flag) when zoomed out, actual encumbrance geometries — scale-gated per class — when zoomed in or when view=boundaries."}},{"name":"Vector tiles, colour-keyed by class","request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiKey}}"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/tiles/{z}/{x}/{y}.mvt","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","tiles","{z}","{x}","{y}.mvt"],"query":[]},"description":"Vector tiles, colour-keyed by class"}},{"name":"One encumbrance, with affected parcels","request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apiKey}}"}],"url":{"raw":"{{baseUrl}}/api/v1/encumbrances/{encumbrance_uid}","host":["{{baseUrl}}"],"path":["api","v1","encumbrances","{encumbrance_uid}"],"query":[]},"description":"One encumbrance, with affected parcels"}}]}],"variable":[{"key":"baseUrl","value":"https://api.starlightsoftware.co.bw"},{"key":"apiKey","value":"YOUR_API_KEY_HERE"}]}