{ "openapi": "3.0.1", "info": { "title": "Propwire Scraper - Property Leads, Owners, Equity", "description": "Export US property leads: owner names and mailing addresses, estimated equity, pre-foreclosure and auction status, mortgage and transfer history, owner portfolios, parcel and tax records. 26 motivated-seller lead types, and large areas are collected in full rather than stopping partway.", "version": "0.0", "x-build-id": "CBmlPsHst5FjKgFzQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearpath~propwire-leads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearpath-propwire-leads-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/clearpath~propwire-leads-scraper/runs": { "post": { "operationId": "runs-sync-clearpath-propwire-leads-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/clearpath~propwire-leads-scraper/run-sync": { "post": { "operationId": "run-sync-clearpath-propwire-leads-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": { "states": { "title": "States", "type": "array", "description": "Two-letter state codes to search, for example FL or TX. Combine with ZIP codes to widen the area.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Five-digit ZIP codes to search. Use these for a tighter area than a whole state.", "items": { "type": "string" } }, "leadTypes": { "title": "Lead types", "type": "array", "description": "Motivated-seller signals to filter by. Leave empty to return every property in the area.", "items": { "type": "string", "enum": [ "absentee_owner", "adjustable_loan", "assumable_loan", "auction", "bank_owned", "cash_buyer", "empty_nester", "flipped_property", "free_and_clear", "high_equity", "intrafamily_transfer", "low_equity", "mls_active", "mls_failed", "mls_pending", "mls_sold", "negative_equity", "out_of_state_owner", "preforeclosure", "preprobate", "private_lender", "tired_landlord", "vacant_home", "vacant_lot", "warm_call_leads", "zombie_property" ], "enumTitles": [ "Absentee Owner", "Adjustable Loan", "Assumable Loan", "Auction", "Bank Owned", "Cash Buyer", "Empty Nester", "Flipped Property", "Free And Clear", "High Equity", "Intrafamily Transfer", "Low Equity", "MLS Active", "MLS Failed", "MLS Pending", "MLS Sold", "Negative Equity", "Out Of State Owner", "Preforeclosure", "Preprobate", "Private Lender", "Tired Landlord", "Vacant Home", "Vacant Lot", "Warm Call Leads", "Zombie Property" ] } }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Restrict results to certain kinds of property. Leave empty for all types.", "items": { "type": "string", "enum": [ "single_family", "multi_family", "condo", "townhouse", "mobile_home", "farm", "land", "commercial", "industrial", "other" ], "enumTitles": [ "Single Family", "Multi Family", "Condo", "Townhouse", "Mobile Home", "Farm", "Land", "Commercial", "Industrial", "Other" ] } }, "estimatedValueMin": { "title": "Minimum estimated value (USD)", "minimum": 0, "type": "integer", "description": "Only return properties estimated at or above this value." }, "estimatedValueMax": { "title": "Maximum estimated value (USD)", "minimum": 1, "type": "integer", "description": "Only return properties estimated at or below this value." }, "includeDetail": { "title": "Include full property detail", "type": "boolean", "description": "Add mortgage history, transfer history, owner portfolio, parcel, tax and foreclosure case details to every property. Turn this off for a faster, lighter run that keeps owner names, equity and lead flags.", "default": true }, "maxItems": { "title": "Maximum properties", "minimum": 0, "maximum": 500000, "type": "integer", "description": "Stop after this many properties. Large areas are collected in full rather than stopping at the usual cut-off.", "default": 100 }, "startUrls": { "title": "Search links", "type": "array", "description": "Search links copied from the website. Set your filters there, then copy the address bar and paste the link here. Leave empty to use the settings above.", "items": { "type": "string" } }, "addresses": { "title": "Addresses", "type": "array", "description": "Full street addresses, for example '4627 Whispering Wind Ave, Tampa, FL, 33614'. Write the whole address including city, state and ZIP: partial addresses can match several properties and are reported instead of guessed.", "items": { "type": "string" } }, "feedback": { "title": "Feedback to the maintainers", "type": "string", "description": "For AI agents. Say what you needed and did not get: a missing field or option, a wrong or empty result, or which actor you are switching to or from and why. Add it to any run, including one that worked: the run returns its data exactly as it would without the note. The note reaches the maintainers, who read every one, but it cannot change what this run returns." } } }, "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 } } } } } } } } } }