{
  "openapi": "3.0.1",
  "info": {
    "title": "REIWA Scraper - WA Property, Agents & Market Data",
    "description": "Scrape REIWA.com.au across sale, rental, sold, commercial, business and rural properties. Search with filters or URLs and extract structured listings, agents, agencies and market insights across Western Australia.",
    "version": "0.1",
    "x-build-id": "2cnytV2TtTVlGYIu9"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/abotapi~reiwa-com-au-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-abotapi-reiwa-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/abotapi~reiwa-com-au-scraper/runs": {
      "post": {
        "operationId": "runs-sync-abotapi-reiwa-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/abotapi~reiwa-com-au-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-abotapi-reiwa-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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "url"
            ],
            "type": "string",
            "description": "search builds REIWA result pages from the fields below. url uses the REIWA URLs you paste.",
            "default": "search"
          },
          "channel": {
            "title": "REIWA section",
            "enum": [
              "for-sale",
              "for-rent",
              "sold",
              "agents",
              "commercial-sale",
              "commercial-lease",
              "business",
              "rural",
              "insights"
            ],
            "type": "string",
            "description": "Choose the result type for search mode. URL mode detects the section from each URL.",
            "default": "for-sale"
          },
          "locations": {
            "title": "Suburbs or regions",
            "type": "array",
            "description": "Search locations such as perth, perth~region, baldivis, or south-west~region. One search runs per location. Leave empty for all available results where the selected section supports it. The find-agents section uses plain names, so perth~region is searched as perth there.",
            "default": [
              "perth~region"
            ],
            "items": {
              "type": "string"
            }
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "default",
              "date-desc",
              "date-asc",
              "price-asc",
              "price-desc"
            ],
            "type": "string",
            "description": "Ordering for result pages that support sorting.",
            "default": "default"
          },
          "urls": {
            "title": "REIWA URLs",
            "type": "array",
            "description": "Only used when mode = url. Paste search/list pages (for sale, rent, sold, commercial, business, rural), agent directories, agent and agency profiles, individual listings, insight lists or insight articles. Multiple URLs are supported. Leave the list as is to scrape one example of each page type.",
            "default": [
              "https://reiwa.com.au/for-sale/perth~region/",
              "https://reiwa.com.au/for-sale/baldivis/",
              "https://reiwa.com.au/for-sale/baldivis/houses/",
              "https://reiwa.com.au/for-sale/baldivis/?minPrice=400000&maxPrice=700000&bedrooms=3&sortBy=price-asc",
              "https://reiwa.com.au/rental-properties/perth/",
              "https://reiwa.com.au/sold/baldivis/",
              "https://reiwa.com.au/commercial/for-sale/perth/",
              "https://reiwa.com.au/commercial/for-lease/perth/",
              "https://reiwa.com.au/business/for-sale/perth/",
              "https://reiwa.com.au/rural/for-sale/south-west~region/",
              "https://reiwa.com.au/real-estate-agents/baldivis/",
              "https://reiwa.com.au/real-estate-agent/adam-dineley-13546-0-567762/",
              "https://reiwa.com.au/real-estate-agency/opal-realty-14506-0/",
              "https://reiwa.com.au/1-canter-lane-baldivis-5049038/",
              "https://reiwa.com.au/the-wa-market/resources/?types=news&page=1",
              "https://reiwa.com.au/news/perth-vacancy-rate-drops-to-lowest-level-in-nearly-two-years/"
            ],
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "title": "Keywords",
            "type": "string",
            "description": "Optional text matched against returned titles, addresses, agencies, descriptions, or article summaries. Applies to search and URL modes.",
            "default": ""
          },
          "propertyTypes": {
            "title": "Property types",
            "type": "array",
            "description": "Optional listing type filters for listing sections. Applies to search and URL modes when supported by the source URL; has no effect when the section is rural.",
            "items": {
              "type": "string",
              "enum": [
                "houses",
                "apartments",
                "units",
                "villas",
                "townhouses",
                "land",
                "rural"
              ],
              "enumTitles": [
                "Houses",
                "Apartments",
                "Units",
                "Villas",
                "Townhouses",
                "Land",
                "Rural"
              ]
            },
            "default": []
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "integer",
            "description": "Optional minimum price. For rentals this is weekly rent."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "integer",
            "description": "Optional maximum price. For rentals this is weekly rent."
          },
          "minBedrooms": {
            "title": "Min bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Optional minimum bedrooms."
          },
          "fetchDetails": {
            "title": "Fetch details",
            "type": "boolean",
            "description": "Adds full descriptions, extra photos, page metadata, and richer contact/profile fields when available. Billed as a detail-enrichment surcharge.",
            "default": false
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Hard cap across the whole run. The actor stops once this many rows are saved.",
            "default": 20
          },
          "maxPages": {
            "title": "Max pages per search",
            "minimum": 0,
            "type": "integer",
            "description": "Optional bound on result pages walked per search/URL. Leave empty to walk every result page. Use Max items as the primary cap."
          },
          "proxy": {
            "title": "Proxy",
            "type": "object",
            "description": "Keep Apify Proxy enabled for stable runs. Use a country setting only if you need a specific geography.",
            "default": {
              "useApifyProxy": true
            }
          },
          "resumeFromRunId": {
            "title": "Resume from run ID",
            "type": "string",
            "description": "Optional: paste a previous run ID (or dataset ID) from this actor. Rows already collected there are skipped, so this run only returns new ones. Leave empty for a normal run. For recurring diff runs (new/changed only on a schedule) you don't need this - turn on Incremental mode below instead."
          },
          "incrementalMode": {
            "title": "Incremental mode (only push new or changed rows)",
            "type": "boolean",
            "description": "ON: the actor remembers the rows it delivered for this exact search scope (keyed automatically, or use State key below) and on each scheduled run classifies every row as NEW, UPDATED, UNCHANGED, REAPPEARED or EXPIRED - pushing only new and changed rows plus EXPIRED tombstones, and stamping each row with changeType, changedFields, firstSeenAt and lastSeenAt. UPDATED is decided by comparing the whole record: price, price value, bedrooms, bathrooms, parking, agency, agents, phone numbers, description, status and every other returned field. It does NOT compare scrapedAt, the relative date label (dateText), the detail status, the photo list, the result page it was found on (sourceUrl), or any field you list under Ignore fields. Use Change scope to compare only price and status. OFF (default): every run returns the full result set like before.",
            "default": false
          },
          "stateKey": {
            "title": "State key (optional)",
            "type": "string",
            "description": "Name for the incremental baseline when Incremental mode is ON. Leave empty to key the baseline on a hash of the search scope automatically (recommended). Use the same key across runs to compare like with like; a different key starts a new baseline."
          },
          "emitUnchanged": {
            "title": "Also push unchanged rows",
            "type": "boolean",
            "description": "With Incremental mode ON, also push rows that did not change (stamped changeType=UNCHANGED). Default OFF - unchanged rows are only remembered, not pushed.",
            "default": false
          },
          "emitExpired": {
            "title": "Push EXPIRED tombstones",
            "type": "boolean",
            "description": "With Incremental mode ON, push a tombstone row (changeType=EXPIRED, last known field values) for rows from the previous run that this run's search no longer returns - only when the search ran to completion (not capped by Max items or Max pages, not resumed, not started at a later page). Default ON.",
            "default": true
          },
          "changeScope": {
            "title": "Change scope (incremental mode only)",
            "enum": [
              "all",
              "priceAndStock"
            ],
            "type": "string",
            "description": "With Incremental mode ON. 'all' (default): any change in the compared fields makes a row UPDATED. 'priceAndStock': only price, price value, listing status and sold date changes make a row UPDATED; descriptions, agents, photos and the other fields never do.",
            "default": "all"
          },
          "compactUpdates": {
            "title": "Compact UPDATED rows (incremental mode only)",
            "type": "boolean",
            "description": "With Incremental mode ON, UPDATED rows carry only id, title, link, current price fields and priceChanges {field: {old, new}} instead of the full record (no detail payload, so no detail charge rides on a compact row). NEW rows stay full. Default OFF.",
            "default": false
          },
          "expireAfterMissedScans": {
            "title": "Expire after N missed scans (incremental mode only)",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "With Incremental mode and Push EXPIRED tombstones ON: a row is tombstoned only after it was missing from this many CONSECUTIVE complete scans (default 1 = the first complete scan that misses it). EXPIRED means the search no longer returned the row; it does not prove the property was sold or withdrawn, since a result-page reshuffle and a withdrawal look the same without a detail probe.",
            "default": 1
          },
          "ignoreFieldsForChanges": {
            "title": "Ignore fields when detecting changes (incremental mode only)",
            "type": "array",
            "description": "With Incremental mode ON, dataset fields listed here never count as a change (they are excluded from changeType/changedFields while staying in the output). Top-level names (e.g. agentNames) or dotted paths (e.g. profileStats.listings). Built-in defaults already cover the scrape timestamp, the relative date label (dateText), the detail status, the photo list (imageUrls) and the result page link (sourceUrl).",
            "items": {
              "type": "string"
            }
          },
          "mcpConnectors": {
            "title": "Pipe results into your apps",
            "type": "array",
            "description": "Send the scraped results into apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify Settings, then select it here. The complete record stays in the dataset. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)."
          },
          "notionParentPageUrl": {
            "title": "Notion parent page",
            "type": "string",
            "description": "URL or id of the Notion page under which item pages are created. Required for Notion export and ignored by other connectors."
          },
          "maxNotifyListings": {
            "title": "Max items to export per connector",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Cap on items written to each selected connector per run. Does not affect the dataset.",
            "default": 50
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}