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/document

Look up a document by its SG key (document number). Requires X-API-KEY header.

Request Body:

{
  "province": "Gauteng",
  "document_no": "D378/2020"
}

Parameters:

The same key exists in more than one province, so the province decides which documents are returned.

POST /api/download/document

Download every page of a document by its SG key. Requires X-API-KEY header.

Request Body:

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

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:

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