{
  "openapi": "3.0.1",
  "info": {
    "title": "Private Property Scraper - South Africa Real Estate",
    "description": "Track South African property prices, spot new listings and build estate agent lead lists from Private Property: homes, flats, commercial and farms for sale or rent, with price, rooms, m², suburb and agency. Add Details for agents, rates, levies, features, photos, tours, map point and listing date.",
    "version": "1.0",
    "x-build-id": "OHGArmdpvxDrGfcxa"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/normdata~privateproperty-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-normdata-privateproperty-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/normdata~privateproperty-scraper/runs": {
      "post": {
        "operationId": "runs-sync-normdata-privateproperty-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/normdata~privateproperty-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-normdata-privateproperty-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "maxItems": {
            "title": "Maximum results",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many listings in total. Leave empty for no limit. The Apify Free plan is always capped at 10."
          },
          "dealType": {
            "title": "Sale or rent",
            "enum": [
              "sale",
              "rent"
            ],
            "type": "string",
            "description": "Properties for sale or to rent."
          },
          "category": {
            "title": "Category",
            "enum": [
              "residential",
              "commercial",
              "farm"
            ],
            "type": "string",
            "description": "Residential (houses, flats, townhouses, plots), commercial or farms."
          },
          "propertyTypes": {
            "title": "Property types",
            "type": "array",
            "description": "Types of the category picked (others are skipped with a warning). Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "House",
                "ApartmentFlat",
                "TownHouseCluster",
                "VacantLandPlot",
                "GardenCottage",
                "Commercial",
                "Hospitality",
                "Industrial",
                "Office",
                "Retail",
                "AgriculturalHolding",
                "CommercialFarm",
                "FarmLand",
                "FarmWithHouse",
                "GameFarm",
                "SmallHolding",
                "Farm"
              ],
              "enumTitles": [
                "Residential: House",
                "Residential: Apartment",
                "Residential: Townhouse",
                "Land (residential or commercial)",
                "Residential: Garden cottage (rent only)",
                "Commercial: Commercial",
                "Commercial: Hospitality",
                "Commercial: Industrial",
                "Commercial: Office",
                "Commercial: Retail",
                "Farm: Agricultural holding",
                "Farm: Commercial farm",
                "Farm: Farm land",
                "Farm: Farm with house",
                "Farm: Game farm",
                "Farm: Smallholding",
                "Farm: Uncategorised farm"
              ]
            }
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Provinces or cities. Empty = all of South Africa.",
            "items": {
              "type": "string",
              "enum": [
                "eastern-cape",
                "free-state",
                "gauteng",
                "kwazulu-natal",
                "limpopo",
                "mpumalanga",
                "north-west",
                "northern-cape",
                "western-cape",
                "amatola",
                "eastern-highlands",
                "frontier-country",
                "karoo-heartland",
                "nelson-mandela-bay",
                "sunshine-coast",
                "wild-coast",
                "central-free-state",
                "eastern-free-state",
                "goldfields",
                "northern-free-state",
                "southern-free-state",
                "centurion",
                "east-rand",
                "gauteng-south",
                "johannesburg",
                "pretoria",
                "west-rand",
                "dolphin-coast",
                "drakensberg",
                "durban",
                "elephant-coast",
                "kzn-midlands",
                "kzn-south-coast",
                "northern-kzn",
                "zululand",
                "limpopo-bushveld",
                "limpopo-lowveld",
                "soutpansberg",
                "waterberg",
                "mpumalanga-escarpment",
                "mpumalanga-highveld",
                "mpumalanga-lowveld",
                "north-west-central",
                "north-west-eastern-bojanala",
                "north-west-southern",
                "north-west-western-bophirima",
                "diamond-fields",
                "green-kalahari",
                "namaqualand",
                "upper-karoo",
                "boland",
                "cape-town",
                "central-karoo",
                "garden-route",
                "little-karoo",
                "overberg",
                "west-coast"
              ],
              "enumTitles": [
                "Eastern Cape",
                "Free State",
                "Gauteng",
                "KwaZulu Natal",
                "Limpopo",
                "Mpumalanga",
                "North West",
                "Northern Cape",
                "Western Cape",
                "Amatola (Eastern Cape)",
                "Eastern Highlands (Eastern Cape)",
                "Frontier Country (Eastern Cape)",
                "Karoo Heartland (Eastern Cape)",
                "Nelson Mandela Bay (Eastern Cape)",
                "Sunshine Coast (Eastern Cape)",
                "Wild Coast (Eastern Cape)",
                "Central Free State (Free State)",
                "Eastern Free State (Free State)",
                "Goldfields (Free State)",
                "Northern Free State (Free State)",
                "Southern Free State (Free State)",
                "Centurion (Gauteng)",
                "East Rand (Gauteng)",
                "Gauteng South (Gauteng)",
                "Johannesburg (Gauteng)",
                "Pretoria (Gauteng)",
                "West Rand (Gauteng)",
                "Dolphin Coast (KwaZulu Natal)",
                "Drakensberg (KwaZulu Natal)",
                "Durban (KwaZulu Natal)",
                "Elephant Coast (KwaZulu Natal)",
                "KZN Midlands (KwaZulu Natal)",
                "KZN South Coast (KwaZulu Natal)",
                "Northern KZN (KwaZulu Natal)",
                "Zululand (KwaZulu Natal)",
                "Limpopo Bushveld (Limpopo)",
                "Limpopo Lowveld (Limpopo)",
                "Soutpansberg (Limpopo)",
                "Waterberg (Limpopo)",
                "Mpumalanga Escarpment (Mpumalanga)",
                "Mpumalanga Highveld (Mpumalanga)",
                "Mpumalanga Lowveld (Mpumalanga)",
                "North West Central (North West)",
                "North West Eastern (Bojanala) (North West)",
                "North West Southern (North West)",
                "North West Western (Bophirima) (North West)",
                "Diamond Fields (Northern Cape)",
                "Green Kalahari (Northern Cape)",
                "Namaqualand (Northern Cape)",
                "Upper Karoo (Northern Cape)",
                "Boland (Western Cape)",
                "Cape Town (Western Cape)",
                "Central Karoo (Western Cape)",
                "Garden Route (Western Cape)",
                "Little Karoo (Western Cape)",
                "Overberg (Western Cape)",
                "West Coast (Western Cape)"
              ]
            }
          },
          "minPrice": {
            "title": "Minimum price (ZAR)",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings from this price, in rand (rent: per month). With a price set, \"POA\" listings are left out."
          },
          "maxPrice": {
            "title": "Maximum price (ZAR)",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings up to this price, in rand."
          },
          "minBedrooms": {
            "title": "Minimum bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Residential and farms."
          },
          "minBathrooms": {
            "title": "Minimum bathrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Residential and farms."
          },
          "minGarages": {
            "title": "Minimum garages",
            "minimum": 0,
            "type": "integer",
            "description": "Residential only."
          },
          "minParking": {
            "title": "Minimum parking spaces",
            "minimum": 0,
            "type": "integer",
            "description": "Residential only."
          },
          "minFloorSize": {
            "title": "Minimum floor size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only properties with at least this floor area."
          },
          "maxFloorSize": {
            "title": "Maximum floor size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only properties with at most this floor area."
          },
          "minLandSize": {
            "title": "Minimum land size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only properties with at least this much land (1 ha = 10,000 m²)."
          },
          "maxLandSize": {
            "title": "Maximum land size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only properties with at most this much land."
          },
          "features": {
            "title": "Features",
            "type": "array",
            "description": "Must have all picked. Residential sale: garden, flatlet, pets, pool, sea view, staff quarters. Residential rent: garden, patio, pets, pool, furnished. Farms: borehole, flatlets, pool, scenic view, staff quarters.",
            "items": {
              "type": "string",
              "enum": [
                "Garden",
                "FlatletOrGardenCottage",
                "PetsAllowed",
                "Pool",
                "SeaView",
                "StaffQuarters",
                "PatioOrBalcony",
                "Furnished",
                "Borehole",
                "Flatlets",
                "ScenicView"
              ],
              "enumTitles": [
                "Garden",
                "Flatlet or garden cottage",
                "Pets allowed",
                "Pool",
                "Sea view",
                "Staff quarters",
                "Patio or balcony",
                "Furnished",
                "Borehole",
                "Flatlets",
                "Scenic view"
              ]
            }
          },
          "security": {
            "title": "Security",
            "type": "array",
            "description": "Must have all picked (residential and farms).",
            "items": {
              "type": "string",
              "enum": [
                "AccessGate",
                "Alarm",
                "ElectricFencing",
                "Intercom",
                "SecurityPost"
              ],
              "enumTitles": [
                "Access gate",
                "Alarm",
                "Electric fencing",
                "Intercom",
                "Security post"
              ]
            }
          },
          "onShow": {
            "title": "On show only",
            "type": "boolean",
            "description": "Only listings with a show day."
          },
          "bankSales": {
            "title": "Bank sales only",
            "type": "boolean",
            "description": "Only repossessed (bank) sales."
          },
          "excludeUnderOffer": {
            "title": "Hide sold and under offer",
            "type": "boolean",
            "description": "Leave out listings marked sold or under offer."
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "default",
              "newest",
              "priceLow",
              "priceHigh",
              "sizeSmall",
              "sizeLarge"
            ],
            "type": "string",
            "description": "Order of the results (the site's own sorting). Default puts promoted listings first."
          },
          "includeDetails": {
            "title": "Details",
            "type": "boolean",
            "description": "Opens each listing's own page for the full description, every agent (name, FFC number, photo, page), agency note and page, rates and taxes, levies, features, every characteristic, all photos, floor plans, video and 3D tour links, map point and listing date."
          },
          "onlyNew": {
            "title": "Only new listings",
            "type": "boolean",
            "description": "Skip listings saved by earlier runs with the same monitor name."
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Runs with the same name share their history. Use a different name for each schedule."
          },
          "startUrls": {
            "title": "Links",
            "type": "array",
            "description": "Private Property results pages (privateproperty.co.za/for-sale/western-cape/cape-town/55?bd=3) or listing pages (privateproperty.co.za/for-sale/western-cape/.../T5373094). Filters are ignored with links.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}