{ "openapi": "3.0.1", "info": { "title": "Auction.com Scraper β€” Foreclosures, REO & Auction Listings", "description": "Scrape Auction.com distressed-property listings β€” foreclosures, bank-owned (REO) and live auctions. Search by location, ZIP, coordinates or URL; pull the auction calendar by state, county and date; get enriched detail (starting bid, deposit, seller terms) and market KPIs.", "version": "1.0", "x-build-id": "eSbHtJEoJ7ELRP8ik" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~auction-com-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-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/sian.agency~auction-com-property-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-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/sian.agency~auction-com-property-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-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": { "operation": { "title": "🧭 Operation", "enum": [ "searchByLocation", "searchByZip", "searchByCoordinates", "searchByUrl", "calendar", "calendarEvent", "detailsById", "detailsByUrl", "autocomplete", "states", "enums", "sell" ], "type": "string", "description": "What to pull from Auction.com.\n\n**Search (listing rows):**\nβ€’ **searchByLocation** β€” city / county / ZIP text (omit for nationwide)\nβ€’ **searchByZip** β€” exact 5-digit ZIP\nβ€’ **searchByCoordinates** β€” lat/long + radius\nβ€’ **searchByUrl** β€” paste an auction.com search or property URL\n\n**Calendar (auction events):**\nβ€’ **calendar** β€” upcoming trustee + online REO sales by state/date\nβ€’ **calendarEvent** β€” one event + all its properties\n\n**Detail (single enriched listing):**\nβ€’ **detailsById** / **detailsByUrl** β€” full financials, terms, photo gallery\n\n**Helpers:**\nβ€’ **autocomplete** β€” resolve a location string\nβ€’ **states / enums / sell** β€” reference lookups", "default": "searchByLocation" }, "location": { "title": "πŸ“ Location", "type": "string", "description": "For **searchByLocation** β€” a city, county or ZIP, e.g. `Dallas, TX`, `Cook County, IL`, `60628`. Leave empty for a nationwide search." }, "zipCode": { "title": "🏷️ ZIP Code", "type": "string", "description": "For **searchByZip** β€” a 5-digit US ZIP, e.g. `60628`." }, "latitude": { "title": "🌐 Latitude", "type": "string", "description": "For **searchByCoordinates** β€” center latitude, e.g. `32.7767`." }, "longitude": { "title": "🌐 Longitude", "type": "string", "description": "For **searchByCoordinates** β€” center longitude, e.g. `-96.797`." }, "radius": { "title": "πŸ“ Radius (miles)", "type": "string", "description": "For **searchByCoordinates** β€” search radius in miles around the point." }, "url": { "title": "πŸ”— Auction.com URL", "type": "string", "description": "For **searchByUrl / detailsByUrl** β€” an auction.com search page (e.g. `https://www.auction.com/residential/tx/`) or a property page (`https://www.auction.com/details/-`)." }, "listingId": { "title": "πŸ†” Listing ID", "type": "string", "description": "For **detailsById** β€” the numeric id from a listing URL or search card, e.g. `2093283`." }, "state": { "title": "πŸ—ΊοΈ State", "type": "string", "description": "For **calendar** β€” 2-letter US state code to scope the calendar, e.g. `TX`." }, "dateFrom": { "title": "πŸ“… Date From", "type": "string", "description": "For **calendar** β€” start of the date window, `YYYY-MM-DD`." }, "dateTo": { "title": "πŸ“… Date To", "type": "string", "description": "For **calendar** β€” end of the date window, `YYYY-MM-DD`." }, "assetType": { "title": "🏚️ Asset Type", "enum": [ "", "foreclosure", "bank-owned" ], "type": "string", "description": "For **calendar** β€” foreclosure (live trustee/courthouse sales) or bank-owned (online REO auctions). Leave empty for any.", "default": "" }, "eventId": { "title": "🎫 Event ID", "type": "string", "description": "For **calendarEvent** β€” an event code (`E-31553A`, `R-101`) or numeric venue id from a calendar row." }, "availability": { "title": "πŸ“¦ Availability", "type": "string", "description": "Search: `active` (live & upcoming, default) or `removed` (closed/sold/pulled). Calendar event: `all`, `available` or `removed`." }, "sort": { "title": "↕️ Sort", "enum": [ "auction_date", "newest", "oldest", "price_low", "price_high", "distance" ], "type": "string", "description": "Search sort order.", "default": "auction_date" }, "enrich": { "title": "⭐ Enrich search results", "type": "boolean", "description": "For search operations β€” fetch the full enriched detail (photo gallery, foreclosure financials, opening bid, deposit and seller terms) for every listing. PAID only; charged per enriched detail.", "default": false }, "maxResults": { "title": "πŸ”’ Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum rows to collect for paginated operations. FREE tier is capped at 60.", "default": 50 } } }, "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 } } } } } } } } } }