{ "openapi": "3.0.1", "info": { "title": "Auction.com Real Estate Auctions Scraper", "description": "Scrape Auction.com (auction.com) real-estate auctions: foreclosure, bank-owned, short sale and private seller listings. Active, sold and cancelled, with address, bids, winning price, auction date, estimates and photos. Export JSON, CSV or Excel.", "version": "1.0", "x-build-id": "UrYZOJTtHDCd1tB7s" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/confidential_gnat~auction-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-confidential_gnat-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/confidential_gnat~auction-com-scraper/runs": { "post": { "operationId": "runs-sync-confidential_gnat-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/confidential_gnat~auction-com-scraper/run-sync": { "post": { "operationId": "run-sync-confidential_gnat-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", "properties": { "startUrls": { "title": "Auction.com URLs", "type": "array", "description": "Search pages and single listing pages. Search pages: https://www.auction.com/residential/ca/active_lt/ (a state, with active_lt, closed_lt for sold or canceled_lt for cancelled), https://www.auction.com/residential/ca/riverside_county/ (a county) or https://www.auction.com/residential/ for the whole country. Listing pages: https://www.auction.com/details/...", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max listings per search or URL", "minimum": 1, "type": "integer", "description": "Maximum listings saved for each start URL or search. The search has no result cap, so this is the only limit.", "default": 5 }, "cacheProjectName": { "title": "Cache project name", "type": "string", "description": "Use the same name on each scheduled run to get only new listings and listings whose status changed (for example from active to sold). Unchanged listings are skipped, not charged and not counted towards Max listings. Each record gets changeType: new or updated. Leave empty to turn the cache off." }, "states": { "title": "States", "type": "array", "description": "Search these states. Used when a start URL has no state, or when no start URL is given. Leave empty for all states.", "items": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "enumTitles": [ "Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "District of Columbia", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming" ] } }, "county": { "title": "County", "type": "string", "description": "Only this county, for example Riverside. Use together with one state." }, "city": { "title": "City", "type": "string", "description": "Only this city, for example Los Angeles. Use together with one state." }, "zip": { "title": "ZIP code", "type": "string", "description": "Only this ZIP code, for example 92262." }, "listingStatus": { "title": "Listing status", "type": "array", "description": "Which listings to include. Sold listings carry the winning bid where the site shows it; cancelled listings were removed before their auction. A status in a start URL (for example closed_lt) overrides this.", "items": { "type": "string", "enum": [ "active", "sold", "cancelled" ], "enumTitles": [ "Active", "Sold", "Cancelled" ] }, "default": [ "active" ] }, "saleTypes": { "title": "Sale type", "type": "array", "description": "Only these kinds of sale. Leave empty for all.", "items": { "type": "string", "enum": [ "foreclosure", "bankOwned", "shortSale", "privateSeller" ], "enumTitles": [ "Foreclosure (trustee sale)", "Bank-owned (REO)", "Short sale", "Private seller" ] } }, "propertyTypes": { "title": "Property type", "type": "array", "description": "Only these property types. Leave empty for all.", "items": { "type": "string", "enum": [ "house", "multiFamily", "condo", "land" ], "enumTitles": [ "Single-family house", "Multi-family", "Condo", "Land" ] } }, "auctionFormat": { "title": "Auction format", "enum": [ "", "online", "inPerson" ], "type": "string", "description": "Online auctions or in-person auctions (courthouse or venue).", "default": "" }, "occupancy": { "title": "Occupancy", "enum": [ "", "vacant" ], "type": "string", "description": "Only vacant properties, or any.", "default": "" }, "minBeds": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Only properties with at least this many bedrooms." }, "minBaths": { "title": "Minimum bathrooms", "minimum": 0, "type": "integer", "description": "Only properties with at least this many bathrooms." }, "minPrice": { "title": "Minimum estimated value ($)", "minimum": 0, "type": "integer", "description": "Only properties with an estimated value at or above this amount (the site filters on the estimated value, not the starting bid)." }, "maxPrice": { "title": "Maximum estimated value ($)", "minimum": 0, "type": "integer", "description": "Only properties with an estimated value at or below this amount." }, "minSqft": { "title": "Minimum living area (sq ft)", "minimum": 0, "type": "integer", "description": "Only properties with at least this living area." }, "maxSqft": { "title": "Maximum living area (sq ft)", "minimum": 0, "type": "integer", "description": "Only properties with at most this living area." }, "minYearBuilt": { "title": "Built in or after (year)", "minimum": 0, "type": "integer", "description": "Only properties built in this year or later." }, "scrapeDetails": { "title": "Open each listing (full details)", "type": "boolean", "description": "On: every listing page is opened for the description, legal description, parcel number (APN), seller terms, venue and sale time, trustee sale number, debt, HOA, all photos and page views. Off: fast records from the search results only (address, price data, bids, auction dates, one photo).", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Auction.com works with the built-in connection, so leaving Apify Proxy off keeps runs cheapest. Turn it on only if you want to use your own proxy IPs.", "default": { "useApifyProxy": 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 } } } } } } } } } }