{
  "openapi": "3.0.1",
  "info": {
    "title": "Property24 Scraper",
    "description": "[💰 $0.65 / 1K] Extract South African property listings from Property24 — prices, beds, baths, parking, floor & land size, photos, agency and agent contacts, levies and rates. Search any suburb for sale, to rent, or recently sold, or paste Property24 URLs directly.",
    "version": "1.0",
    "x-build-id": "LXvmqmzX4EeqnvFKo"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/solidcode~property24-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-solidcode-property24-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/solidcode~property24-scraper/runs": {
      "post": {
        "operationId": "runs-sync-solidcode-property24-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/solidcode~property24-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-solidcode-property24-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": {
          "searchLocations": {
            "title": "Search Locations",
            "type": "array",
            "description": "Cities, suburbs, or regions to search, e.g. \"Cape Town\", \"Sandton\", or \"Sea Point, Cape Town\". Each location runs as its own search. Leave empty if you are pasting Property24 URLs below.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Paste Property24 search or suburb URLs directly, e.g. \"https://www.property24.com/for-sale/cape-town/western-cape/432\". Any filters already in the URL are kept. When provided, the filter settings below do NOT apply to these URLs.",
            "items": {
              "type": "string"
            }
          },
          "dealType": {
            "title": "Listing Type",
            "enum": [
              "for_sale",
              "to_rent",
              "sold"
            ],
            "type": "string",
            "description": "Search properties for sale, to rent, or already sold. Only applies to Search Locations — ignored for pasted URLs.",
            "default": "for_sale"
          },
          "propertyTypes": {
            "title": "Property Types",
            "uniqueItems": true,
            "type": "array",
            "description": "Only include these property types. Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "house",
                "apartment_flat",
                "townhouse",
                "vacant_land",
                "farm",
                "commercial",
                "industrial"
              ],
              "enumTitles": [
                "House",
                "Apartment / Flat",
                "Townhouse",
                "Vacant Land / Plot",
                "Farm / Smallholding",
                "Commercial Property",
                "Industrial Property"
              ]
            },
            "default": []
          },
          "priceMin": {
            "title": "Minimum Price (ZAR)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include properties at or above this price, in South African Rand. Leave empty for no minimum."
          },
          "priceMax": {
            "title": "Maximum Price (ZAR)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include properties at or below this price, in South African Rand. Leave empty for no maximum."
          },
          "bedroomsMin": {
            "title": "Minimum Bedrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Only include properties with at least this many bedrooms. Leave empty for any."
          },
          "bathroomsMin": {
            "title": "Minimum Bathrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Only include properties with at least this many bathrooms. Leave empty for any."
          },
          "parkingMin": {
            "title": "Minimum Parking Spaces",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Only include properties with at least this many parking spaces. Leave empty for any."
          },
          "floorSizeMin": {
            "title": "Minimum Floor Size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include properties with at least this floor (building) area, in square metres. Leave empty for any."
          },
          "floorSizeMax": {
            "title": "Maximum Floor Size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include properties with at most this floor (building) area, in square metres. Leave empty for any."
          },
          "landSizeMin": {
            "title": "Minimum Land Size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include properties with at least this erf (land) area, in square metres. Leave empty for any."
          },
          "landSizeMax": {
            "title": "Maximum Land Size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include properties with at most this erf (land) area, in square metres. Leave empty for any."
          },
          "furnished": {
            "title": "Furnishing",
            "enum": [
              "any",
              "furnished",
              "unfurnished"
            ],
            "type": "string",
            "description": "Filter by furnishing. Most relevant for rentals.",
            "default": "any"
          },
          "features": {
            "title": "Features",
            "uniqueItems": true,
            "type": "array",
            "description": "Only include properties that offer all of these features. Leave empty for no feature filter.",
            "items": {
              "type": "string",
              "enum": [
                "pet_friendly",
                "garden",
                "pool",
                "flatlet"
              ],
              "enumTitles": [
                "Pet-friendly",
                "Garden",
                "Swimming pool",
                "Flatlet / Granny flat"
              ]
            },
            "default": []
          },
          "rentalPeriod": {
            "title": "Rental Period",
            "enum": [
              "any",
              "monthly",
              "weekly",
              "daily",
              "yearly",
              "per_square_metre"
            ],
            "type": "string",
            "description": "Rental term to filter by. Only applies when Listing Type is \"To Rent\".",
            "default": "any"
          },
          "sortBy": {
            "title": "Sort Order",
            "enum": [
              "default",
              "most_recent",
              "lowest_price",
              "highest_price",
              "size"
            ],
            "type": "string",
            "description": "Order in which results are returned by Property24.",
            "default": "default"
          },
          "maxResults": {
            "title": "Max Results",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of listings to collect across all locations and URLs. Set to 0 to collect all available results (each search reads up to 1,000 result pages, far more than any Property24 area holds). Tip: start with 10-50 to test, then increase.",
            "default": 100
          },
          "includeListingDetails": {
            "title": "Include Full Listing Details",
            "type": "boolean",
            "description": "Open each listing's detail page for richer data: full description, all photos, agent and agency contacts, levies, and rates & taxes. Much more complete, but noticeably slower. Leave off for a fast run that returns the fields shown on the search results.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}