{
  "openapi": "3.0.1",
  "info": {
    "title": "Realestate.com.au Scraper",
    "description": "Scrape property listings from realestate.com.au and realestate.co.nz. Get prices, addresses, bedrooms, bathrooms, car spaces, land size, property type, agent name and phone, map coordinates and the full photo set. Search by URL, single property, or location and export to JSON, CSV or Excel.",
    "version": "1.0",
    "x-build-id": "R90LzLteTqqB3z3WB"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~realestate-com-au-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-realestate-com-au-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/silentflow~realestate-com-au-scraper/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-realestate-com-au-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/silentflow~realestate-com-au-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-realestate-com-au-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": {
          "startUrls": {
            "title": "🔗 Start URLs",
            "type": "array",
            "description": "realestate.com.au or realestate.co.nz search URLs (buy, rent or sold) or single property URLs, copied from your browser. This field only takes links: to search by suburb, postcode or listing ID, use Search locations below.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "searchQueries": {
            "title": "📍 Search locations",
            "type": "array",
            "description": "Suburbs, postcodes or regions to search on realestate.com.au (properties for sale), one per line: <code>Surry Hills</code>, <code>Richmond, VIC 3121</code>, <code>2000</code>. Each one returns the same listings as the website's search bar. A listing ID (<code>152321968</code>) returns that one property.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "🔢 Maximum results per search",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of listings to return per search URL, location or filter search.",
            "default": 200
          },
          "searchByFilters": {
            "title": "Search by filters",
            "type": "object",
            "description": "Country (<code>au</code> or <code>nz</code>), channel (<code>buy</code>, <code>rent</code>, <code>sold</code>) and location. For New Zealand, type a city, district or suburb (<code>Christchurch</code>, <code>Te Aro, Wellington</code>)."
          },
          "minPrice": {
            "title": "💲 Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest price in AUD, per week for rentals. Example: <code>800000</code> to buy, <code>600</code> to rent."
          },
          "maxPrice": {
            "title": "💲 Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "Highest price in AUD, per week for rentals. Example: <code>1500000</code>."
          },
          "propertyTypes": {
            "title": "🏠 Property types",
            "type": "array",
            "description": "Only these property types. Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "house",
                "townhouse",
                "apartment",
                "villa",
                "land",
                "acreage",
                "rural",
                "blockOfUnits",
                "retirement"
              ],
              "enumTitles": [
                "House",
                "Townhouse",
                "Apartment and unit",
                "Villa",
                "Land",
                "Acreage",
                "Rural",
                "Block of units",
                "Retirement living"
              ]
            }
          },
          "minBedrooms": {
            "title": "🛏️ Minimum bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at least this many bedrooms. Example: <code>3</code>."
          },
          "maxBedrooms": {
            "title": "🛏️ Maximum bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at most this many bedrooms."
          },
          "minBathrooms": {
            "title": "🛁 Minimum bathrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at least this many bathrooms."
          },
          "minCarSpaces": {
            "title": "🚗 Minimum car spaces",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at least this many car spaces."
          },
          "minLandSize": {
            "title": "📐 Minimum land size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at least this much land, in square metres. Example: <code>600</code>."
          },
          "maxLandSize": {
            "title": "📐 Maximum land size (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at most this much land, in square metres."
          },
          "keywords": {
            "title": "🏊 Keywords",
            "type": "array",
            "description": "Features the listing must mention, one per line: <code>pool</code>, <code>garage</code>, <code>ocean view</code>.",
            "items": {
              "type": "string"
            }
          },
          "constructionStatus": {
            "title": "🏗️ New or established",
            "enum": [
              "any",
              "new",
              "established"
            ],
            "type": "string",
            "description": "Only new builds (off the plan, house and land) or only established homes.",
            "default": "any"
          },
          "listingOptions": {
            "title": "✅ Listing options",
            "type": "array",
            "description": "Hide under contract, auction, private sale or no-price listings. For rentals: furnished, pets allowed, or hide deposit taken.",
            "items": {
              "type": "string",
              "enum": [
                "excludeUnderContract",
                "excludeAuctions",
                "excludePrivateSales",
                "excludeNoDisplayPrice",
                "furnished",
                "petsAllowed",
                "excludeDepositTaken"
              ],
              "enumTitles": [
                "Hide under contract",
                "Hide auctions",
                "Hide private sales",
                "Hide listings without a price",
                "Furnished only (rent)",
                "Pets allowed only (rent)",
                "Hide deposit taken (rent)"
              ]
            }
          },
          "soldWithinMonths": {
            "title": "📅 Sold within the last months",
            "minimum": 1,
            "maximum": 36,
            "type": "integer",
            "description": "For sold searches: only properties sold in the last N months. Example: <code>6</code> for recent comparable sales."
          },
          "sortBy": {
            "title": "↕️ Sort by",
            "enum": [
              "relevance",
              "newest",
              "price-asc",
              "price-desc"
            ],
            "type": "string",
            "description": "Order of the results, which decides which listings come back when the maximum is reached. Newest means recently listed (recently sold for sold searches).",
            "default": "relevance"
          },
          "includeDetails": {
            "title": "Include full details",
            "type": "boolean",
            "description": "Read each realestate.com.au property page: listing agent and phone, agency name, address and phone, headline, full description, auction and open-home times, coordinates, land and floor size, property features and every photo. Turn off for a faster run with search data only.",
            "default": true
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}