{ "openapi": "3.0.1", "info": { "title": "Auction.com Property Scraper", "description": "Scrape property auction listings from Auction.com. Extract property details including address, price, auction date, property type, square footage, bedrooms, bathrooms, and more. Supports filtering by state, property type, and price range.", "version": "1.0", "x-build-id": "aqK0bmGeslTCEIBKA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~auction-com-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~auction-com-property-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~auction-com-property-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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": "Auction.com search URL", "type": "string", "description": "Paste any Auction.com search URL. Apply your filters on the website, copy the address bar, and the Actor reads every filter from it. Leave this empty to use the search fields below instead." }, "searchTerm": { "title": "Location", "type": "string", "description": "City, ZIP code, or US state to search. Examples: Atlanta, 30301, GA, California. Ignored when a search URL is provided above." }, "saleTypes": { "title": "Sale types", "type": "array", "description": "Which kinds of sale to include. Defaults to all three.", "items": { "type": "string", "enum": [ "foreclosures", "bank-owned", "private-seller" ], "enumTitles": [ "Foreclosures", "Bank owned", "Private seller" ] } }, "propTypes": { "title": "Property types", "type": "array", "description": "Which property types to include. Defaults to all four.", "items": { "type": "string", "enum": [ "single-family", "multi-family", "condos-townhouses", "land" ], "enumTitles": [ "Single family", "Multi family", "Condos and townhouses", "Land" ] } }, "buyingTypes": { "title": "Buying methods", "type": "array", "description": "How the property can be bought. Defaults to all methods.", "items": { "type": "string", "enum": [ "online", "in_person", "remote_bid", "offer" ], "enumTitles": [ "Online auction", "In person", "Remote bid", "Make an offer" ] } }, "minBeds": { "title": "Minimum bedrooms", "minimum": 1, "type": "integer", "description": "Only return properties with at least this many bedrooms." }, "minBaths": { "title": "Minimum bathrooms", "minimum": 1, "type": "integer", "description": "Only return properties with at least this many bathrooms." }, "sqftMin": { "title": "Minimum square footage", "minimum": 0, "type": "integer", "description": "Only return properties at or above this interior square footage." }, "sqftMax": { "title": "Maximum square footage", "minimum": 0, "type": "integer", "description": "Only return properties at or below this interior square footage." }, "conditionFlags": { "title": "Property condition", "type": "array", "description": "Extra condition filters offered by Auction.com. Leave empty for no condition filtering.", "items": { "type": "string", "enum": [ "Vacant", "Private Tour Available", "Eligible for Financing", "Inspection Contingency Offered" ] } }, "featuredFlags": { "title": "Featured tags", "type": "array", "description": "Auction.com marketing tags such as Price Drop or $1 Opening Bid. Leave empty for no tag filtering.", "items": { "type": "string", "enum": [ "Foreclosure Predict", "Hot Foreclosure", "Hot Bank Owned", "Untapped Deals", "Price Drop", "$1 Opening Bid", "Rural Properties", "Now Vacant", "Interior Photos", "Inspection Reports" ] } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of properties to collect. Free users: limited to 10 items (preview). Paid users: optional, up to 1,000,000." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Auction.com blocks datacenter IPs, so US residential proxies are used by default. Change this only if you know your own proxies reach the site.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "countryCode": "US" } }, "includePartyContacts": { "title": "📇 Include party contacts", "type": "boolean", "description": "Adds a partyContacts list to each property: every named party on the file with their role, name, email, phone and licence number (asset manager, listing agent, broker, foreclosure attorney, servicer, trustor, beneficiary). It rides the same search request, so it is no extra request. Charged only for a row that receives it.", "default": false }, "includePropertyMedia": { "title": "🖼️ Include property media", "type": "boolean", "description": "Adds a propertyMedia block to each property: the full photo gallery URLs, not just the cover shot, plus the published WEB documents with their download links. It rides the same search request, so it is no extra request. Charged only for a row that receives it.", "default": false }, "includeListingRemarks": { "title": "📝 Include listing remarks", "type": "boolean", "description": "Adds a listingRemarks block to each property: the marketing description, the recorded legal description, special notes and additional seller terms. It rides the same search request, so it is no extra request. Charged only for a row that receives it.", "default": false }, "includeAuctionTerms": { "title": "⚖️ Include auction terms", "type": "boolean", "description": "Adds an auctionTerms block to each property: buyer's premium and earnest money minimums and rates, deed types, title provider and insurance, financing, estimated debt, final judgement and credit bid amounts, HOA dues, APN, seller valuation, the auction event code, the courthouse or venue with its directions and URL, the local bid start and end times, and the page view count. It rides the same search request, so it is no extra request. Charged only for a row that receives it.", "default": false }, "includeBidStatus": { "title": "🔨 Include bid status", "type": "boolean", "description": "Adds a bidStatus block to each property that has an online auction segment: starting bid, live bid count, bid increment, reserve amount and reserve status, segment status, the current highest bid and the winning bid. Properties sold at a courthouse have no online segment and are never charged. It rides the same search request, so it is no extra request. Charged only for a row that receives it.", "default": false } } }, "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 } } } } } } } } } }