{
  "openapi": "3.0.1",
  "info": {
    "title": "Realestate.com.au Scraper - Australia Property",
    "description": "Scrape Australia property listings from realestate.com.au search URLs: price, bedrooms, bathrooms, parking, land size, full address, agency and agents, inspections, auctions and images. Buy, rent and sold channels. Bypasses anti-bot protection. Paste search URLs or import a file.",
    "version": "0.1",
    "x-build-id": "nG75Ed7bJ5cHxEbyf"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~realestate-com-au-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~realestate-com-au-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-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/scrapesage~realestate-com-au-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-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": "realestate.com.au search URLs",
            "type": "array",
            "description": "realestate.com.au search URLs, one per line. Build a search on realestate.com.au with your filters (suburb, price, beds...), then paste the URL from the address bar. Buy, rent and sold channels all work. <b>Leave empty and the run returns a small free sample.</b>",
            "items": {
              "type": "string"
            }
          },
          "startUrlsFromFile": {
            "title": "Import URLs from a file",
            "type": "string",
            "description": "Bulk-load realestate.com.au URLs. Either <b>paste the whole list</b> (one per line), or give <b>a single link</b> to a public <code>.txt</code>/<code>.csv</code>, a Google Sheet/Drive link, or an Apify key-value-store record. A file that cannot be read says so and charges nothing."
          },
          "maxPagesPerUrl": {
            "title": "Max pages per URL",
            "minimum": 1,
            "type": "integer",
            "description": "How many result pages to follow for each start URL (25 listings per page; realestate.com.au itself serves at most ~24 pages per search).",
            "default": 10
          },
          "maxItems": {
            "title": "Max listings (total)",
            "minimum": 1,
            "type": "integer",
            "description": "Overall cap across all URLs. You are only charged for listings actually saved.",
            "default": 1000
          },
          "outputFields": {
            "title": "Output fields (leave empty for all)",
            "type": "array",
            "description": "Pick the fields you want and every record is trimmed to exactly those - handy for lean CSV/Sheets exports.",
            "items": {
              "type": "string",
              "enum": [
                "type",
                "id",
                "url",
                "channel",
                "matchType",
                "title",
                "priceText",
                "price",
                "priceFrom",
                "priceTo",
                "pricePeriod",
                "propertyType",
                "propertyTypeId",
                "bedrooms",
                "bathrooms",
                "parkingSpaces",
                "studies",
                "landSize",
                "landSizeUnit",
                "buildingSize",
                "buildingSizeUnit",
                "shortAddress",
                "fullAddress",
                "suburb",
                "state",
                "postcode",
                "description",
                "agencyName",
                "agencyId",
                "agencyUrl",
                "agencyLogo",
                "agencyAvgRating",
                "agencyTotalReviews",
                "agents",
                "agentName",
                "listingTier",
                "badge",
                "auctionDate",
                "nextInspection",
                "inspectionCount",
                "dateSold",
                "images",
                "image",
                "imageCount",
                "hasFloorplan",
                "hasVideo",
                "has3DTour",
                "sourceUrl",
                "scrapedAt"
              ],
              "enumTitles": [
                "Record type (type)",
                "Listing id (id)",
                "Listing URL (url)",
                "Channel buy/rent/sold (channel)",
                "Match type (matchType)",
                "Title / address (title)",
                "Price text (priceText)",
                "Price numeric (price)",
                "Price from (priceFrom)",
                "Price to (priceTo)",
                "Price period (pricePeriod)",
                "Property type (propertyType)",
                "Property type id (propertyTypeId)",
                "Bedrooms (bedrooms)",
                "Bathrooms (bathrooms)",
                "Parking spaces (parkingSpaces)",
                "Studies (studies)",
                "Land size (landSize)",
                "Land size unit (landSizeUnit)",
                "Building size (buildingSize)",
                "Building size unit (buildingSizeUnit)",
                "Short address (shortAddress)",
                "Full address (fullAddress)",
                "Suburb (suburb)",
                "State (state)",
                "Postcode (postcode)",
                "Description (description)",
                "Agency name (agencyName)",
                "Agency id (agencyId)",
                "Agency URL (agencyUrl)",
                "Agency logo (agencyLogo)",
                "Agency avg rating (agencyAvgRating)",
                "Agency review count (agencyTotalReviews)",
                "Agents list (agents)",
                "Lead agent (agentName)",
                "Listing tier (listingTier)",
                "Badge (badge)",
                "Auction date (auctionDate)",
                "Next inspection (nextInspection)",
                "Inspection count (inspectionCount)",
                "Date sold (dateSold)",
                "Image URLs (images)",
                "Main image (image)",
                "Image count (imageCount)",
                "Has floorplan (hasFloorplan)",
                "Has video (hasVideo)",
                "Has 3D tour (has3DTour)",
                "Source URL (sourceUrl)",
                "Scraped at (scrapedAt)"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}