{ "openapi": "3.0.1", "info": { "title": "Propwire Distressed & High-Equity Property Lead Finder", "description": "Search Propwire by city, state, or ZIP and pull property, owner, equity, MLS, and tax data tagged with lead-type flags like absentee owner, high equity, vacant, and pre-foreclosure.", "version": "1.0", "x-build-id": "1vR0Cz4HPqF7tkeVe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~propwire-distressed-and-high-equity-property-lead/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-propwire-distressed-and-high-equity-property-lead", "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/vexaloom-labs~propwire-distressed-and-high-equity-property-lead/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-propwire-distressed-and-high-equity-property-lead", "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/vexaloom-labs~propwire-distressed-and-high-equity-property-lead/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-propwire-distressed-and-high-equity-property-lead", "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": [ "properties", "propertyDetails", "owners", "ownerDetails" ], "type": "string", "description": "What to fetch. Property search is the default and cheapest mode.", "default": "properties" }, "locations": { "title": "Locations", "type": "array", "description": "US places to search (mode=properties, owners): 'Miami, FL', 'Miami-Dade County, FL', or a 5-digit ZIP. Add one entry per place. A bare state code is accepted but Propwire's search API is unreliable for state-wide queries; use a city, county or ZIP for stable results. St./Ft./Mt. abbreviations are expanded automatically.", "items": { "type": "string" } }, "searchUrls": { "title": "Saved Propwire search URLs", "type": "array", "description": "Optional (mode=properties). Paste one or more propwire.com/search?filters=... links copied from your browser; the actor replays the same area and filters. When present, these URLs take precedence over Locations and the filter fields below. Property URLs are also accepted as an ID shortcut.", "items": { "type": "string" } }, "propertyIds": { "title": "Property IDs or URLs", "type": "array", "description": "Property IDs (e.g. 88441) or propwire.com/realestate/... URLs (mode=properties, propertyDetails). Results are deduplicated.", "items": { "type": "string" } }, "ownerProfileIds": { "title": "Owner profile IDs or URLs", "type": "array", "description": "32-character agent / cash-buyer profile IDs, or propwire.com/agents/ and /cash-buyers/ URLs (mode=ownerDetails).", "items": { "type": "string" } }, "peopleType": { "title": "Owner lead type", "enum": [ "cash_buyer", "agent" ], "type": "string", "description": "Which owner directory to search (mode=owners).", "default": "cash_buyer" }, "ownerName": { "title": "Owner name contains", "type": "string", "description": "Optional (mode=owners). Case-insensitive name fragment, e.g. 'Smith'." }, "transactionsMin": { "title": "Minimum transactions", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional (mode=owners). Minimum recorded transactions / deals." }, "transactionsMax": { "title": "Maximum transactions", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional (mode=owners). Maximum recorded transactions / deals." }, "ownerPropertiesMin": { "title": "Minimum properties owned", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional (mode=owners). Minimum properties in the owner's portfolio." }, "ownerPropertiesMax": { "title": "Maximum properties owned", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional (mode=owners). Maximum properties in the owner's portfolio." }, "avgSalePriceMin": { "title": "Minimum average sale price (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=owners)." }, "avgSalePriceMax": { "title": "Maximum average sale price (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=owners)." }, "lastTransactionFrom": { "title": "Last transaction from", "type": "string", "description": "Optional (mode=owners). Date in YYYY-MM-DD format." }, "lastTransactionTo": { "title": "Last transaction to", "type": "string", "description": "Optional (mode=owners). Date in YYYY-MM-DD format." }, "ownerSortBy": { "title": "Owner sort field", "enum": [ "transactions", "avg_sale_price", "properties_owned", "last_transaction_date" ], "type": "string", "description": "Optional (mode=owners)." }, "leadTypes": { "title": "Lead types", "type": "array", "description": "Optional (mode=properties). Only properties carrying every selected flag are returned. Supported free flags: 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, zombie_property. Paid-membership flags are ignored and named in the run status.", "items": { "type": "string" } }, "propertyTypes": { "title": "Property types", "uniqueItems": true, "type": "array", "description": "Optional (mode=properties). Leave empty for every type.", "items": { "type": "string", "enum": [ "single_family", "condo", "multi_family_2_to_4", "multi_family_5_plus", "mobile", "land", "commercial", "other" ], "enumTitles": [ "Single-family home", "Condo or townhouse", "Multi-family (2-4 units)", "Multi-family (5+ units)", "Mobile or manufactured", "Land", "Commercial", "Other" ] }, "default": [] }, "ownerKinds": { "title": "Owner kinds", "uniqueItems": true, "type": "array", "description": "Optional (mode=properties). Restrict to individual, company, or bank-owned properties.", "items": { "type": "string", "enum": [ "individual", "company", "bank" ], "enumTitles": [ "Individual", "Company / LLC", "Bank or trust" ] }, "default": [] }, "bedsMin": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 100, "type": "integer", "description": "Optional (mode=properties)." }, "bedsMax": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 100, "type": "integer", "description": "Optional (mode=properties)." }, "bathsMin": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 100, "type": "number", "description": "Optional (mode=properties)." }, "bathsMax": { "title": "Maximum bathrooms", "minimum": 0, "maximum": 100, "type": "number", "description": "Optional (mode=properties)." }, "storiesMin": { "title": "Minimum stories", "minimum": 0, "maximum": 100, "type": "integer", "description": "Optional (mode=properties)." }, "storiesMax": { "title": "Maximum stories", "minimum": 0, "maximum": 100, "type": "integer", "description": "Optional (mode=properties)." }, "sqftMin": { "title": "Minimum building area (sqft)", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Optional (mode=properties)." }, "sqftMax": { "title": "Maximum building area (sqft)", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Optional (mode=properties)." }, "lotSqftMin": { "title": "Minimum lot size (sqft)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Optional (mode=properties)." }, "lotSqftMax": { "title": "Maximum lot size (sqft)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Optional (mode=properties)." }, "yearBuiltMin": { "title": "Year built from", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Optional (mode=properties)." }, "yearBuiltMax": { "title": "Year built to", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Optional (mode=properties)." }, "unitsMin": { "title": "Minimum units", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Optional (mode=properties)." }, "unitsMax": { "title": "Maximum units", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Optional (mode=properties)." }, "valueMin": { "title": "Minimum estimated value (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "valueMax": { "title": "Maximum estimated value (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "equityMin": { "title": "Minimum estimated equity (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "equityMax": { "title": "Maximum estimated equity (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "equityPercentMin": { "title": "Minimum equity percent", "minimum": 0, "maximum": 100, "type": "integer", "description": "Optional (mode=properties). 0-100." }, "equityPercentMax": { "title": "Maximum equity percent", "minimum": 0, "maximum": 100, "type": "integer", "description": "Optional (mode=properties). 0-100." }, "ltvMin": { "title": "Minimum loan-to-value", "minimum": 0, "maximum": 200, "type": "integer", "description": "Optional (mode=properties)." }, "ltvMax": { "title": "Maximum loan-to-value", "minimum": 0, "maximum": 200, "type": "integer", "description": "Optional (mode=properties)." }, "lastSoldPriceMin": { "title": "Minimum last sale price (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "lastSoldPriceMax": { "title": "Maximum last sale price (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "lastSoldDateFrom": { "title": "Last sale date from", "type": "string", "description": "Optional (mode=properties). YYYY-MM-DD." }, "lastSoldDateTo": { "title": "Last sale date to", "type": "string", "description": "Optional (mode=properties). YYYY-MM-DD." }, "assessedValueMin": { "title": "Minimum assessed value (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "assessedValueMax": { "title": "Maximum assessed value (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "yearsOwnedMin": { "title": "Minimum years owned", "minimum": 0, "maximum": 200, "type": "integer", "description": "Optional (mode=properties)." }, "yearsOwnedMax": { "title": "Maximum years owned", "minimum": 0, "maximum": 200, "type": "integer", "description": "Optional (mode=properties)." }, "propertiesOwnedMin": { "title": "Minimum properties owned by owner", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional (mode=properties)." }, "propertiesOwnedMax": { "title": "Maximum properties owned by owner", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional (mode=properties)." }, "portfolioValueMin": { "title": "Minimum owner portfolio value (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "portfolioValueMax": { "title": "Maximum owner portfolio value (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "taxDelinquentSince": { "title": "Tax delinquent since (year)", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Optional (mode=properties). Minimum tax-delinquent year." }, "ownerOccupied": { "title": "Owner occupied", "enum": [ "any", "true", "false" ], "type": "string", "description": "Optional (mode=properties).", "default": "any" }, "outOfStateOwner": { "title": "Out-of-state owner", "enum": [ "any", "true", "false" ], "type": "string", "description": "Optional (mode=properties).", "default": "any" }, "vacant": { "title": "Vacancy", "enum": [ "any", "true", "false" ], "type": "string", "description": "Optional (mode=properties).", "default": "any" }, "pool": { "title": "Pool", "enum": [ "any", "true", "false" ], "type": "string", "description": "Optional (mode=properties).", "default": "any" }, "privateLender": { "title": "Private lender", "enum": [ "any", "true", "false" ], "type": "string", "description": "Optional (mode=properties).", "default": "any" }, "cashBuyer": { "title": "Cash buyer", "enum": [ "any", "true", "false" ], "type": "string", "description": "Optional (mode=properties).", "default": "any" }, "preforeclosure": { "title": "Pre-foreclosure", "enum": [ "any", "true", "false" ], "type": "string", "description": "Optional (mode=properties).", "default": "any" }, "noticeType": { "title": "Foreclosure notice type", "enum": [ "lis_pendens", "notice_of_default", "notice_of_trustee_sale", "notice_of_sale", "reo" ], "type": "string", "description": "Optional (mode=properties)." }, "noticeDateFrom": { "title": "Notice date from", "type": "string", "description": "Optional (mode=properties). YYYY-MM-DD." }, "noticeDateTo": { "title": "Notice date to", "type": "string", "description": "Optional (mode=properties). YYYY-MM-DD." }, "auctionDateFrom": { "title": "Auction date from", "type": "string", "description": "Optional (mode=properties). YYYY-MM-DD." }, "auctionDateTo": { "title": "Auction date to", "type": "string", "description": "Optional (mode=properties). YYYY-MM-DD." }, "openingBidMin": { "title": "Minimum auction opening bid (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "openingBidMax": { "title": "Maximum auction opening bid (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "mlsStatus": { "title": "MLS listing status", "enum": [ "active", "pending", "sold", "failed" ], "type": "string", "description": "Optional (mode=properties)." }, "daysOnMarketMin": { "title": "Minimum days on market", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional (mode=properties)." }, "daysOnMarketMax": { "title": "Maximum days on market", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional (mode=properties)." }, "listPriceMin": { "title": "Minimum MLS list price (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "listPriceMax": { "title": "Maximum MLS list price (USD)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Optional (mode=properties)." }, "sortBy": { "title": "Property sort field", "enum": [ "estimated_value", "estimated_equity", "equity_percent", "last_sold_price", "last_sold_date", "list_price", "list_price_per_sqft", "days_on_market", "living_area", "year_built" ], "type": "string", "description": "Optional (mode=properties)." }, "sortOrder": { "title": "Sort order", "enum": [ "desc", "asc" ], "type": "string", "description": "Used by sortBy and ownerSortBy.", "default": "desc" }, "includeDetails": { "title": "Fetch full property details", "type": "boolean", "description": "Optional (mode=properties). Adds one detail request per property: parcel/APN, mortgages, transfer history, foreclosure, tax bill and photos. Slower and uses more requests; leave off for large lists.", "default": false }, "includeProfile": { "title": "Fetch full owner profiles", "type": "boolean", "description": "Optional (mode=owners). Adds one profile request per owner: email, license, recent listings or cash-buyer portfolio.", "default": false }, "maxItems": { "title": "Maximum records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum records to push across all locations (default 50 when omitted). Propwire serves at most 10,000 rows per search." } } }, "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 } } } } } } } } } }