{ "openapi": "3.0.1", "info": { "title": "Auction.com $1💰 URL Search | Keyword Filtering | Rich Output", "description": "From $1/1K. Extract foreclosure, REO, short-sale, and auction listings from Auction.com in minutes. Search by location and property filters or paste any Auction.com URL. Get 45+ structured fields, including auction dates, bids, estimated values, occupancy status, coordinates, and photos.", "version": "1.0", "x-build-id": "w2DDyxNFg6l6Cbacs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~auction-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-auction-com-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/abotapi~auction-com-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-auction-com-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/abotapi~auction-com-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-auction-com-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "url" ], "type": "string", "description": "How to find listings. 'search' builds the query from the filter fields below. 'url' takes one or more Auction.com search URLs you paste.", "default": "search" }, "states": { "title": "States", "type": "array", "description": "Two-letter US state codes to search, e.g. CA, TX, FL. Leave empty to search nationwide.", "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "Optional city name to narrow the search, e.g. Los Angeles. Combine with a single state for best results." }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Optional list of 5-digit ZIP codes to narrow the search.", "items": { "type": "string" } }, "keyword": { "title": "Keyword / address", "type": "string", "description": "Optional free-text search across street, city, state and ZIP, e.g. 'Main St' or '90210'." }, "listingStatus": { "title": "Listing status", "enum": [ "active", "sold" ], "type": "string", "description": "Active listings open for bidding, or sold/closed listings.", "default": "active" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Filter by property category. Leave empty for all.", "items": { "type": "string", "enum": [ "single-family", "condos-townhouses", "multi-family", "land" ], "enumTitles": [ "Single Family", "Condos / Townhouses", "Multi Family", "Land" ] } }, "assetTypes": { "title": "Asset types", "type": "array", "description": "Filter by distressed-asset category. Leave empty for all.", "items": { "type": "string", "enum": [ "bank-owned", "foreclosures", "short-sales", "private-seller" ], "enumTitles": [ "Bank Owned / REO", "Foreclosures", "Short Sales", "Private Seller" ] } }, "auctionFormats": { "title": "Auction formats", "type": "array", "description": "Filter by how the auction is run. Leave empty for all.", "items": { "type": "string", "enum": [ "online", "in-person", "remote-bid" ], "enumTitles": [ "Online", "In Person", "Remote Bid" ] } }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBeds": { "title": "Max bedrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms." }, "minSqft": { "title": "Min square footage", "minimum": 0, "type": "integer", "description": "Minimum living area in square feet." }, "maxSqft": { "title": "Max square footage", "minimum": 0, "type": "integer", "description": "Maximum living area in square feet." }, "minPrice": { "title": "Min starting bid", "minimum": 0, "type": "integer", "description": "Minimum starting bid in USD." }, "maxPrice": { "title": "Max starting bid", "minimum": 0, "type": "integer", "description": "Maximum starting bid in USD." }, "sortBy": { "title": "Sort by", "enum": [ "default", "auction-date-asc", "auction-date-desc", "price-asc", "price-desc", "newest" ], "type": "string", "description": "Result ordering.", "default": "default" }, "urls": { "title": "Auction.com URLs", "type": "array", "description": "One or more Auction.com search URLs. Apply filters on the website, copy the URL, and paste it here. Multiple URLs supported; pagination walks forward from the page in each URL. Search-mode filter fields above are ignored.", "items": { "type": "string" } }, "fetchDetails": { "title": "Fetch full details", "type": "boolean", "description": "Make an extra request per listing for the full photo gallery, complete auction terms, deposit/financing details and documents. Slower and billed per detail page; off by default.", "default": false }, "maxPages": { "title": "Max pages per search", "minimum": 0, "type": "integer", "description": "Optional bound on result pages walked per search/URL (100 listings per page). Use 0 to walk the whole catalogue: the run stops on its own once the site's reported total is reached, a page comes back empty, or a page returns no new listings. This does NOT cap the number of listings; use Max listings for that.", "default": 0 }, "maxListings": { "title": "Max listings", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Hard cap on total listings collected. 0 means unlimited (paid plans).", "default": 20 }, "resumeFromRunId": { "title": "Resume from a previous run (delta)", "type": "string", "description": "Optional. ID of a previous run of this actor (or a dataset ID). Listings already in that dataset are skipped, so this run returns only NEW listings (a delta). Combine both runs' datasets for the full set. Max listings then counts only the new listings. For recurring daily monitoring of the same search, use Incremental mode below instead." }, "incrementalMode": { "title": "Incremental changes for scheduled runs", "type": "boolean", "description": "Turn this on for daily or recurring monitoring. The first run returns all matching listings as NEW. Later runs normally return only NEW, UPDATED, and REAPPEARED listings. Turn on \"Emit unchanged\" or \"Emit expired\" only when you also want those listings returned (and billed). State is kept separately for each distinct search/filter setup (or by State key below).", "default": false }, "stateKey": { "title": "State key (optional, incremental mode only)", "type": "string", "description": "Optional. Name this monitoring campaign to keep its state stable, or to deliberately share state across differently-configured runs. Leave empty to let the actor derive a key automatically from your search/filter settings — different searches then never mix state with each other." }, "emitUnchanged": { "title": "Emit unchanged listings (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return listings that have not changed since the last run, marked UNCHANGED. This returns — and bills — extra rows you already have, so leave it off unless you specifically want the full snapshot every run.", "default": false }, "emitExpired": { "title": "Emit expired listings (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return listings that were present in a previous run but are no longer found, marked EXPIRED. Only produced once a run has fully scanned the tracked search — not when Max listings or Max pages capped it, or when Resume was used. This returns — and bills — extra synthetic rows.", "default": false }, "proxy": { "title": "Proxy", "type": "object", "description": "Proxy configuration. Apify datacenter (the default) works well for this source; no residential proxy required.", "default": { "useApifyProxy": true } }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send the scraped results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify → Settings → Integrations, then select it here. The connector receives a condensed, human-readable summary per item (title + key fields), not the full JSON — the complete record stays in the dataset. Leave empty to skip. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)." }, "notionParentPageUrl": { "title": "Notion parent page (Notion connector only)", "type": "string", "description": "URL (or id) of the Notion page under which item pages are created. Required to enable the Notion export; ignored by other connectors." }, "maxNotifyListings": { "title": "Max items to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on items written to each connector per run. Does not affect the dataset.", "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 } } } } } } } } } }