API for searching property records on the SG Office website.
Health check endpoint. No authentication required.
Look up a document by its SG key (document number). Requires X-API-KEY header.
{
"province": "Gauteng",
"document_no": "D378/2020"
}
province - Province name (e.g., "Gauteng", "Western Cape")document_no - The SG key, matched exactly (e.g., "D378/2020")The same key exists in more than one province, so the province decides which documents are returned.
Download every page of a document by its SG key. Requires X-API-KEY header.
{
"province": "Gauteng",
"document_no": "D378/2020",
"force_refresh": false, // Optional - re-download even if cached
"convert_to_pdf": false // Optional - convert TIFF pages to PDF
}
Returns pre-signed S3 URLs for each page. Repeat requests are served from cache.
Search for property records. Requires X-API-KEY header.
{
"province": "Western Cape",
"area_type": "Urban",
"town_regdiv": "Durbanville",
"parcel_no": "1960",
"portion_no": "0",
"town_index": 0 // Optional - index to select when multiple towns returned
}
province - Province name (e.g., "Western Cape", "Gauteng")area_type - "Rural" or "Urban"town_regdiv - Town name (Urban) or Registration Division (Rural)parcel_no - Erf number (Urban) or Farm number (Rural)portion_no - Portion number (use "0" for full property)town_index - (Optional) When search returns multiple towns, use this index to select one{
"success": true,
"result": {
"status": "town_selection_required",
"message": "Multiple towns found. Please select one by providing town_index parameter.",
"towns": ["DURBANVILLE", "DURBANVILLE EXT 1", "DURBANVILLE EXT 2"]
}
}
{
"success": true,
"result": {
"status": "results",
"data": [...],
"property_details": {...}
}
}