SG Office Property Search API

API for searching property records on the SG Office website.

GET /api/ping

Health check endpoint. No authentication required.

POST /api/search/property

Search for property records. Requires X-API-KEY header.

Request Body:

{
  "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
}

Parameters:

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

Response (when multiple towns found):

{
  "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"]
  }
}

Response (with results):

{
  "success": true,
  "result": {
    "status": "results",
    "data": [...],
    "property_details": {...}
  }
}