{
  "openapi": "3.0.1",
  "info": {
    "title": "Real Estate AU | URLs, Filters, History & Insights",
    "description": "Extract detailed Australian real estate property listings with 30+ structured fields, including price, description, indoor and outdoor features, coordinates, nearby schools, agent contact details, images, and listing price history where available.",
    "version": "2.0",
    "x-build-id": "ekwLsYkmHr6nfclZ0"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/abotapi~realestate-au-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-abotapi-realestate-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~realestate-au-scraper/runs": {
      "post": {
        "operationId": "runs-sync-abotapi-realestate-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~realestate-au-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-abotapi-realestate-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": "1. Search mode",
            "enum": [
              "location",
              "url"
            ],
            "type": "string",
            "description": "Location mode = pick suburb + state + filters below. URL mode = paste any search URL already refined in a browser (recommended for complex filters or multi-suburb queries).",
            "default": "location"
          },
          "locations": {
            "title": "Locations to search (Location mode)",
            "type": "array",
            "description": "Locations to search. Suburb, state, and postcode are all optional - provide whichever you have. Example: Sydney / NSW.",
            "items": {
              "type": "object",
              "properties": {
                "suburb": {
                  "title": "Suburb (Optional)",
                  "type": "string",
                  "description": "Suburb or city name. Leave empty for state-wide search.",
                  "editor": "textfield"
                },
                "state": {
                  "title": "State (Optional)",
                  "type": "string",
                  "description": "Australian state or territory",
                  "enum": [
                    "NSW",
                    "VIC",
                    "QLD",
                    "SA",
                    "WA",
                    "TAS",
                    "NT",
                    "ACT"
                  ],
                  "editor": "select"
                },
                "postcode": {
                  "title": "Postcode (Optional)",
                  "type": "string",
                  "description": "4-digit postcode for suburb-level precision",
                  "editor": "textfield",
                  "pattern": "^[0-9]{4}$"
                }
              }
            }
          },
          "listingType": {
            "title": "Listing Type (Location mode)",
            "enum": [
              "buy",
              "rent",
              "sold"
            ],
            "type": "string",
            "description": "Type of property listings to scrape. Location mode only.",
            "default": "buy"
          },
          "sortBy": {
            "title": "Sort Order",
            "enum": [
              "relevance",
              "list-date",
              "list-date-asc",
              "price-asc",
              "price-desc",
              "next-inspection-time",
              "next-auction-time"
            ],
            "type": "string",
            "description": "Sort order for search results. Only applies in location mode.",
            "default": "list-date"
          },
          "dateRange": {
            "title": "Sold Date Range",
            "enum": [
              "30days",
              "3months",
              "6months",
              "12months",
              "all"
            ],
            "type": "string",
            "description": "How far back to search for sold listings. Only applies when listing type is 'Recently Sold'.",
            "default": "6months"
          },
          "propertyTypes": {
            "title": "Property Types",
            "type": "array",
            "description": "Filter by property type (leave empty for all)",
            "items": {
              "type": "string",
              "enum": [
                "house",
                "apartment",
                "townhouse",
                "villa",
                "land",
                "rural",
                "commercial",
                "other"
              ],
              "enumTitles": [
                "House",
                "Apartment/Unit",
                "Townhouse",
                "Villa",
                "Land",
                "Rural",
                "Commercial",
                "Other"
              ]
            }
          },
          "priceMin": {
            "title": "Minimum Price",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum property price (AUD)"
          },
          "priceMax": {
            "title": "Maximum Price",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum property price (AUD)"
          },
          "bedroomsMin": {
            "title": "Minimum Bedrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Minimum number of bedrooms"
          },
          "bedroomsMax": {
            "title": "Maximum Bedrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Maximum number of bedrooms"
          },
          "bathroomsMin": {
            "title": "Minimum Bathrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Minimum number of bathrooms"
          },
          "includeSurrounding": {
            "title": "Include Surrounding Suburbs",
            "type": "boolean",
            "description": "Include properties from surrounding suburbs in results.",
            "default": true
          },
          "urls": {
            "title": "Search URLs (URL mode)",
            "type": "array",
            "description": "Search result page URLs to scrape. The /list-N/ segment sets the starting page; pagination then continues forward up to Maximum Pages. Tip: open the site, apply your filters in a browser, then paste the resulting URL here. In URL mode, all the filter fields above are ignored.",
            "items": {
              "type": "string"
            }
          },
          "includeNearbySchools": {
            "title": "Include Nearby Schools",
            "type": "boolean",
            "description": "Fetch nearby schools for each listing (uses coordinates), grouped into primary, secondary, and combined (K-12). Adds ~0.5s per listing.",
            "default": false
          },
          "includePriceHistory": {
            "title": "Include Price History",
            "type": "boolean",
            "description": "Enable this to add a full historical timeline (every prior sale, listing, lease, and withdrawal - with date, price, and listing agent) to each result. Off by default - leave unticked if you do not need it. Adds ~1-2s per listing. Billed only when a non-empty timeline is successfully attached; no charge if the lookup returns no events.",
            "default": false
          },
          "includePcaInsights": {
            "title": "Include Market Insights & Forecast",
            "type": "boolean",
            "description": "Enable this to attach property valuation (sale + rental AVM with confidence range), suburb market trends (median price/rent + 12-month growth), planning overlays (bushfire/flood/heritage), council, NBN connection type, school zoning, nearby childcare centres, built year, mobile coverage, and media counts to each result. Off by default. Adds ~1-2s per listing. Billed once per listing whose insights successfully attach; no charge on lookup failures. Can be combined with Include Price History — both share a single backend call.",
            "default": false
          },
          "maxListings": {
            "title": "Maximum Listings",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after scraping this many listings. Set to 0 for unlimited.",
            "default": 20
          },
          "maxPages": {
            "title": "Maximum Pages per Location",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum search result pages to process per location. Each page has ~20 results. Set to 0 for unlimited (default).",
            "default": 0
          },
          "resumeFromRunId": {
            "title": "Resume from a previous run",
            "type": "string",
            "description": "Paste a previous run ID or dataset ID to continue a large crawl of properties without returning or charging for properties already collected there. Use this after an interrupted run, or when continuing a large pull in another run. For recurring daily monitoring of the same search, use Incremental mode below instead."
          },
          "incrementalMode": {
            "title": "Incremental changes for scheduled runs",
            "type": "boolean",
            "description": "Turn this on for daily or recurring monitoring. The first run returns all matching properties as NEW. Later runs normally return only NEW, UPDATED, and REAPPEARED properties. Turn on \"Emit unchanged\" or \"Emit expired\" only when you also want those properties returned (and billed). State is kept separately for each location/URL and filter/enrichment setup; use State key when you want to name or deliberately share a monitoring campaign. To continue one specific interrupted run instead, use Resume from a previous run above.",
            "default": false
          },
          "stateKey": {
            "title": "State key (optional, incremental mode only)",
            "type": "string",
            "description": "Optional. Name this monitoring campaign to keep its state stable, or to deliberately share state across differently-configured runs. Leave empty to let the actor derive a key automatically from the location/URL and filter/enrichment settings — different searches then never mix state with each other."
          },
          "emitUnchanged": {
            "title": "Emit unchanged properties (incremental mode only)",
            "type": "boolean",
            "description": "Off by default. Turn on to also return properties that have not changed since the last run, marked UNCHANGED. This returns — and bills — extra rows you already have, so leave it off unless you specifically want the full snapshot every run.",
            "default": false
          },
          "emitExpired": {
            "title": "Emit expired properties (incremental mode only)",
            "type": "boolean",
            "description": "Off by default. Turn on to also return properties that were present in a previous run but are no longer found, marked EXPIRED. Only produced once a run has fully scanned the tracked search — not when Max listings/Max pages capped it or when Resume was used. This returns — and bills — extra synthetic rows, so leave it off unless you need expiry tracking.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Configure proxy."
          },
          "mcpConnectors": {
            "title": "Pipe results into your apps (optional)",
            "type": "array",
            "description": "Optionally send the scraped results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify → Settings → Integrations, then select it here. Notion gets a page per item; other connectors receive a best-effort write/digest. Leave empty to skip — this never changes the dataset output. 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 (Notion connector only)",
            "type": "string",
            "description": "URL (or id) of the Notion page under which item pages are created. Required to enable the Notion export; 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 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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}