{ "openapi": "3.0.1", "info": { "title": "Distressed Property Scraper: Mortgagee Sales AU & NZ", "description": "Find mortgagee-sale and distressed-property listings in Australia and New Zealand. NZ results require a confirmed mortgagee-sale flag; AU results use keyword filtering. Get property, price, location and agent details, plus auction dates where available. Resume runs or track incremental changes", "version": "1.0", "x-build-id": "WyOrvWgGPnoTfoLpt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~distressed-au-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-distressed-au-nz-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~distressed-au-nz-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-distressed-au-nz-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~distressed-au-nz-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-distressed-au-nz-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": { "mode": { "title": "Mode", "enum": [ "search", "url" ], "type": "string", "description": "How to discover records. 'search' walks the selected country lanes with your filters. 'url' reads only the links you paste into urls. Pasted links are ignored in search mode; the run log tells you when that happens.", "default": "search" }, "country": { "title": "Country lanes", "type": "array", "description": "Which registers to walk, in order. New Zealand = mortgagee-flagged listings from the national property register. Australia = keyword-filtered mortgagee-sale results. Each selected lane uses its own filters below.", "items": { "enum": [ "nz", "au" ], "type": "string" } }, "urls": { "title": "URLs", "type": "array", "description": "Pasted source links (any supported site); grouped by site automatically. Read in url mode.", "items": { "type": "string" } }, "nzRegion": { "title": "NZ: Region (optional)", "enum": [ "", "auckland", "bay-of-plenty", "canterbury", "central-north-island", "central-otago-lakes-district", "coromandel", "gisborne", "hawkes-bay", "manawatu-whanganui", "marlborough", "nelson-bays", "northland", "otago", "pacific-islands", "southland", "taranaki", "waikato", "wairarapa", "wellington", "west-coast" ], "type": "string", "description": "Limit the New Zealand walk to one district. Empty = national walk." }, "nzListingType": { "title": "NZ: Listing pool (optional)", "enum": [ "", "residential", "rural", "commercial", "rental" ], "type": "string", "description": "Limit to one New Zealand listing pool. Empty = residential sale, the mortgagee-sale pool." }, "auState": { "title": "AU: State (optional)", "enum": [ "", "act", "nsw", "nt", "qld", "sa", "tas", "vic", "wa" ], "type": "string", "description": "Limit the Australian walk to one state or territory. Empty = national walk." }, "auListingType": { "title": "AU: Listing type", "enum": [ "buy", "rent", "sold" ], "type": "string", "description": "Which Australian listing pool to walk. Buy is the mortgagee-sale pool; rent and sold are supported for completeness." }, "auPropertyType": { "title": "AU: Property type (optional)", "enum": [ "", "house", "apartment", "townhouse", "villa", "land", "rural", "commercial" ], "type": "string", "description": "Limit to one Australian property type. Empty = all types." }, "auBedroomsMin": { "title": "AU: Min bedrooms (optional)", "minimum": 0, "type": "integer", "description": "Minimum bedrooms. Selects the bedroom path segment of the search URL." }, "auBedroomsMax": { "title": "AU: Max bedrooms (optional)", "minimum": 0, "type": "integer", "description": "Maximum bedrooms (upper bound). Rides the search as a query filter." }, "auPriceMin": { "title": "AU: Min price AUD (optional)", "minimum": 0, "type": "integer", "description": "Minimum price in AUD. Lower bound of the price path segment." }, "auPriceMax": { "title": "AU: Max price AUD (optional)", "minimum": 0, "type": "integer", "description": "Maximum price in AUD. Upper bound of the price path segment." }, "auExcludes": { "title": "AU: Exclude words (optional)", "type": "array", "description": "Advanced: drop rows whose title contains any of these words (case-insensitive). Example: [\"sold\", \"leased\"].", "items": { "type": "string" } }, "fetchDetails": { "title": "Fetch detail pages", "type": "boolean", "description": "Open each result's detail page (full description, extra fields). Adds one request per record; disable for fast listing-only runs." }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Stop after this many results total across all lanes. 0 = no limit (run until the walks end)." }, "maxPages": { "title": "Max pages per search (0 = unlimited)", "minimum": 0, "type": "integer", "description": "Stop each search walk after this many result pages. 0 = walk until the natural end. Max items always applies too." }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Connection used for requests. New Zealand works with the standard pool; the Australian lane automatically uses residential exits (set when the Australia lane is selected)." }, "resumeFromRunId": { "title": "Resume from run ID", "type": "string", "description": "Continue a previous run: only records not already in that run's dataset are pushed. Leave empty for a fresh run." }, "incrementalMode": { "title": "Incremental mode", "type": "boolean", "description": "Track records across scheduled runs with the same scope: only NEW or UPDATED records are returned (UNCHANGED suppressed), and records that disappear are marked EXPIRED. Mutually exclusive with Resume." }, "stateKey": { "title": "State key (optional)", "type": "string", "description": "Name for the incremental baseline when you want to share one baseline across different filter variants. Leave empty to derive it from the scope automatically." }, "emitUnchanged": { "title": "Emit unchanged records", "type": "boolean", "description": "In incremental mode, also return records that did not change (marked UNCHANGED)." }, "emitExpired": { "title": "Emit expired records", "type": "boolean", "description": "In incremental mode, also return records seen previously that no longer appear (marked EXPIRED)." }, "ignoreFieldsForChanges": { "title": "Ignore fields when detecting changes (incremental mode only)", "type": "array", "description": "Advanced: record fields that should never count as a change (in addition to the built-in ignore list). Example: [\"updatedAt\"].", "items": { "type": "string" } }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send a summary of each returned property to connected apps. Authorize a connector under Apify > Settings > Integrations, then select it here. Notion creates a page per record; other connectors receive a best-effort write or digest. Leave empty to skip. Dataset results are unaffected." }, "notionParentPageUrl": { "title": "Notion parent page (Notion connector only)", "type": "string", "description": "URL or ID of the Notion page where record pages should be created. Required for Notion; ignored by other connectors." }, "maxNotifyListings": { "title": "Max items to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of records written to each connector. Does not affect dataset output.", "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 } } } } } } } } } }