{ "openapi": "3.0.1", "info": { "title": "Foreclosed Property Scraper (Cheap)", "description": "Foreclosed properties list tool that extracts distressed real estate inventory across the US, giving investors direct access to off-market and foreclosure deals.", "version": "0.0", "x-build-id": "9JgBTSwOl69Q1oQSe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data_api~foreclosed-property-scraper-cheap/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data_api-foreclosed-property-scraper-cheap", "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/data_api~foreclosed-property-scraper-cheap/runs": { "post": { "operationId": "runs-sync-data_api-foreclosed-property-scraper-cheap", "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/data_api~foreclosed-property-scraper-cheap/run-sync": { "post": { "operationId": "run-sync-data_api-foreclosed-property-scraper-cheap", "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": { "postalCode": { "title": "ZIP code", "type": "string", "description": "Narrow the search to a single 5-digit US ZIP code. This is the tightest way to focus on one neighborhood. For instance, use '33139' for Miami Beach, FL." }, "stateCode": { "title": "State abbreviation", "type": "string", "description": "Cast a wider net with a 2-letter US state code. Works best paired with another filter. For example, 'FL' for Florida or 'TX' for Texas." }, "cityName": { "title": "City", "type": "string", "description": "Match a single city by its exact name. Pairing it with stateCode gives the cleanest results. Try 'Miami' or 'Dallas'." }, "streetName": { "title": "Street", "type": "string", "description": "Limit results to homes sitting on one named street, such as 'Ocean Drive' or 'Elm St'." }, "addressLine": { "title": "Full address line", "type": "string", "description": "Search for one precise street address, for example '742 Evergreen Terrace'." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Keep only the property categories you care about. Accepted values: apartment, condo_townhome, condo_townhome_rowhome_coop, condo, condos, single_family, multi_family, mobile, land, farm, other.", "items": { "type": "string" } }, "featureKeywords": { "title": "Amenity keywords", "type": "array", "description": "Screen listings by amenities or standout features. Try values like: basement, carport, central_air, den, hardwood_floors, pool, waterfront, ocean_view, fireplace.", "items": { "type": "string" } }, "bedsMin": { "title": "Bedrooms from", "type": "integer", "description": "Lowest acceptable bedroom count." }, "bedsMax": { "title": "Bedrooms up to", "type": "integer", "description": "Highest acceptable bedroom count." }, "bathsMin": { "title": "Bathrooms from", "type": "integer", "description": "Lowest bathroom count to allow, half-baths counted." }, "bathsMax": { "title": "Bathrooms up to", "type": "integer", "description": "Highest bathroom count to allow." }, "listPriceMin": { "title": "Asking price from", "type": "integer", "description": "Floor on the current listed asking price, in USD." }, "listPriceMax": { "title": "Asking price up to", "type": "integer", "description": "Ceiling on the current listed asking price, in USD." }, "soldPriceMin": { "title": "Sold price from", "type": "integer", "description": "Floor on the final sold price, in USD." }, "soldPriceMax": { "title": "Sold price up to", "type": "integer", "description": "Ceiling on the final sold price, in USD." }, "soldDateFrom": { "title": "Sold on or after", "type": "string", "description": "Keep only homes that closed on or after this date, written as YYYY-MM-DD." }, "soldDateTo": { "title": "Sold on or before", "type": "string", "description": "Keep only homes that closed on or before this date, written as YYYY-MM-DD." }, "sqftMin": { "title": "Living area from (sqft)", "type": "integer", "description": "Smallest interior living area to include, measured in square feet." }, "sqftMax": { "title": "Living area up to (sqft)", "type": "integer", "description": "Largest interior living area to include, measured in square feet." }, "lotSqftMin": { "title": "Lot size from (sqft)", "type": "integer", "description": "Smallest outdoor lot size to include, measured in square feet." }, "lotSqftMax": { "title": "Lot size up to (sqft)", "type": "integer", "description": "Largest outdoor lot size to include, measured in square feet." }, "yearBuiltFrom": { "title": "Built on or after", "type": "integer", "description": "Earliest construction year to allow." }, "yearBuiltTo": { "title": "Built on or before", "type": "integer", "description": "Latest construction year to allow; lower it to surface older builds." }, "hoaFeeMax": { "title": "HOA fee cap", "type": "integer", "description": "Largest monthly Homeowners Association fee you are willing to accept." }, "excludeHoa": { "title": "Skip HOA properties", "type": "boolean", "description": "Turn this on to return only homes with zero Homeowners Association fees.", "default": false }, "openHouseFrom": { "title": "Open house on or after", "type": "string", "description": "Only show homes with an open house scheduled on or after this date (YYYY-MM-DD)." }, "openHouseTo": { "title": "Open house on or before", "type": "string", "description": "Only show homes with an open house scheduled on or before this date (YYYY-MM-DD)." }, "pageSize": { "title": "Listings per request", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many listings to fetch in one call to the source. Default 150.", "default": 150 }, "startOffset": { "title": "Starting position", "minimum": 0, "type": "integer", "description": "The positional index where pagination begins. Default 0.", "default": 0 }, "resultsLimit": { "title": "Total listings cap", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The hard ceiling on how many listings the run collects across every page. Default 3000.", "default": 3000 }, "runTimeoutSeconds": { "title": "Whole-run time budget (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Once the run exceeds this many seconds, it wraps up cleanly and exits. Default 360.", "default": 360 }, "requestTimeoutSeconds": { "title": "Single-request time budget (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long to wait on each individual request before giving up on it. Default 45.", "default": 45 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Pick the proxies that route your requests so you stay under the radar and avoid blocks. US datacenter proxies are the default." } } }, "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 } } } } } } } } } }