{ "openapi": "3.0.1", "info": { "title": "Auction Property Scraper (Cheap)", "description": "Auction properties extractor designed for heavy-hitting cash buyers, house flippers, and wholesale deal-makers looking to instantly spot distressed property liquidations.", "version": "0.0", "x-build-id": "ovDsEaupX0rsdbOVe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data_api~auction-property-scraper-cheap/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data_api-auction-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~auction-property-scraper-cheap/runs": { "post": { "operationId": "runs-sync-data_api-auction-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~auction-property-scraper-cheap/run-sync": { "post": { "operationId": "run-sync-data_api-auction-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 sharpest way to pin results to one neighborhood. For instance, use '33139' for Miami Beach, FL." }, "stateCode": { "title": "State abbreviation", "type": "string", "description": "Widen the search to a whole state using its 2-letter code. Pairs well with other filters. For example, 'TX' for Texas or 'GA' for Georgia." }, "cityName": { "title": "City", "type": "string", "description": "Match an exact city name. Works best when combined with a state code. For example, 'Phoenix' or 'Tampa'." }, "streetName": { "title": "Street", "type": "string", "description": "Limit results to a named street. For example, 'Ocean Drive' or 'Elm St'." }, "addressLine": { "title": "Full address line", "type": "string", "description": "Look up one precise property address line, such as '742 Evergreen Terrace'." }, "propertyCategories": { "title": "Property categories", "type": "array", "description": "Keep only the property kinds you care about. Accepted values include: apartment, condo_townhome, condo_townhome_rowhome_coop, condo, condos, single_family, multi_family, mobile, land, farm, other.", "items": { "type": "string" } }, "featureTerms": { "title": "Amenity keywords", "type": "array", "description": "Restrict listings to ones carrying certain features. Accepted values include: basement, carport, central_air, den, hardwood_floors, pool, waterfront, ocean_view, fireplace.", "items": { "type": "string" } }, "bedroomsMin": { "title": "Bedrooms from", "type": "integer", "description": "Lowest bedroom count to accept." }, "bedroomsMax": { "title": "Bedrooms to", "type": "integer", "description": "Highest bedroom count to accept." }, "bathroomsMin": { "title": "Bathrooms from", "type": "integer", "description": "Lowest bathroom count to accept, half-baths included." }, "bathroomsMax": { "title": "Bathrooms to", "type": "integer", "description": "Highest bathroom count to accept." }, "listPriceMin": { "title": "Asking price from", "type": "integer", "description": "Floor for the active asking price, in US dollars." }, "listPriceMax": { "title": "Asking price to", "type": "integer", "description": "Ceiling for the active asking price, in US dollars." }, "soldPriceMin": { "title": "Sold price from", "type": "integer", "description": "Floor for the recorded sold price, in US dollars." }, "soldPriceMax": { "title": "Sold price to", "type": "integer", "description": "Ceiling for the recorded sold price, in US dollars." }, "yearBuiltMin": { "title": "Built no earlier than", "type": "integer", "description": "Earliest construction year to include." }, "yearBuiltMax": { "title": "Built no later than", "type": "integer", "description": "Latest construction year to include; use it to focus on newer or older stock." }, "hoaFeeMax": { "title": "HOA fee ceiling", "type": "integer", "description": "Highest monthly Homeowners Association fee you will tolerate." }, "pageSize": { "title": "Listings per request", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many listings are pulled in each single API call.", "default": 150 }, "startOffset": { "title": "Starting position", "minimum": 0, "type": "integer", "description": "The zero-based index where paging begins.", "default": 0 }, "resultsLimit": { "title": "Total listings cap", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper bound on how many listings the run collects across every page. Default `3000`.", "default": 500 }, "runTimeoutSeconds": { "title": "Whole-run timeout (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Once the run passes this many seconds, it shuts down cleanly and returns whatever it has. Default `420`.", "default": 420 }, "timeoutSeconds": { "title": "Per-request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long to wait on each API slice before giving up on it. Default `45`.", "default": 45 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Pick proxies to mask your IP and stay clear of blocks. US datacenter proxies are the default and handle most runs." } } }, "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 } } } } } } } } } }