{ "openapi": "3.0.1", "info": { "title": "Auction.com Property Scraper", "description": "Discover real estate investment opportunities with Auction.com Property Scraper. Extract foreclosure listings, REO properties, auction prices, bidding details, property addresses, and auction dates. Find potential deals, track property auctions, and analyze investment markets.", "version": "0.0", "x-build-id": "5HuCplaPj5UoNcPZq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shahidirfan~Auction-com-Property-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shahidirfan-Auction-com-Property-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/shahidirfan~Auction-com-Property-Scraper/runs": { "post": { "operationId": "runs-sync-shahidirfan-Auction-com-Property-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/shahidirfan~Auction-com-Property-Scraper/run-sync": { "post": { "operationId": "run-sync-shahidirfan-Auction-com-Property-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": { "startUrl": { "title": "Search URL", "type": "string", "description": "An Auction.com search results URL. When set, it takes priority over Location and the filter fields." }, "location": { "title": "Location", "type": "string", "description": "City, county, state or ZIP code, for example Chicago, IL or 90210. Used when Search URL is empty.", "default": "Chicago, IL" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Property types to include. Leave all selected to search every type.", "items": { "type": "string", "enum": [ "single-family", "multi-family", "condos-townhouses", "land" ] }, "default": [ "single-family", "multi-family", "condos-townhouses", "land" ] }, "auctionTypes": { "title": "Auction types", "type": "array", "description": "Sale formats to include. Leave all selected to search every format.", "items": { "type": "string", "enum": [ "online", "in_person", "remote_bid", "offer" ] }, "default": [ "online", "in_person", "remote_bid", "offer" ] }, "assetTypes": { "title": "Asset types", "type": "array", "description": "Asset categories to include. Leave empty to search every category.", "items": { "type": "string", "enum": [ "bank-owned", "foreclosures", "newly-foreclosed", "short-sales", "private-seller", "rentals" ] }, "default": [] }, "bedsMin": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Lowest bedroom count to include." }, "bathsMin": { "title": "Minimum bathrooms", "minimum": 0, "type": "number", "description": "Lowest bathroom count to include. Fractions such as 1.5 are allowed." }, "minSqft": { "title": "Minimum square feet", "minimum": 0, "type": "integer", "description": "Smallest living area to include, in square feet." }, "radiusMiles": { "title": "Search radius (miles)", "minimum": 1, "maximum": 100, "type": "integer", "description": "How far around the resolved city, ZIP or address to search when using Location.", "default": 50 }, "sortBy": { "title": "Sort order", "enum": [ "auction_date_order", "resi_sort_v2", "asset_activation_dt_sort", "resi_property_address", "beds", "baths", "sqft", "valuation_estimate", "distance" ], "type": "string", "description": "Order of listings returned by the search.", "default": "auction_date_order" }, "results_wanted": { "title": "Maximum listings", "minimum": 1, "type": "integer", "description": "The maximum number of listings to save.", "default": 20 }, "max_pages": { "title": "Maximum pages", "minimum": 1, "type": "integer", "description": "A safety cap on how many result pages to request.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Auction.com blocks many non-US addresses. Use a US proxy such as Apify Proxy.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }