{ "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": "0.1", "x-build-id": "4jQdO72syZOKE4QCf" }, "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", "required": [ "search_term" ], "properties": { "search_term": { "title": "Search Location", "type": "string", "description": "The location to search for auction properties. Can be a zip code, city, or state (e.g., '30311', 'Atlanta', 'New York', 'Los Angeles', 'GA', 'California')", "default": "Atlanta" }, "sale_types": { "title": "Sale Types", "uniqueItems": true, "type": "array", "description": "Types of properties to include in the search", "items": { "type": "string", "enum": [ "bank-owned", "foreclosures", "private-seller", "newly-foreclosed" ], "enumTitles": [ "Bank Owned", "Foreclosures", "Private Seller", "Newly Foreclosed" ] }, "default": [ "bank-owned", "foreclosures", "private-seller" ] }, "min_beds": { "title": "Minimum Bedrooms", "minimum": 1, "maximum": 4, "type": "integer", "description": "Minimum number of bedrooms (1-4, or leave empty for any)" }, "min_baths": { "title": "Minimum Bathrooms", "minimum": 1, "maximum": 4, "type": "integer", "description": "Minimum number of bathrooms (1-4, or leave empty for any)" }, "sqft_min": { "title": "Minimum Square Footage", "minimum": 0, "type": "integer", "description": "Minimum square footage (or leave empty for any)" }, "sqft_max": { "title": "Maximum Square Footage", "minimum": 0, "type": "integer", "description": "Maximum square footage (or leave empty for any)" }, "prop_types": { "title": "Property Types", "uniqueItems": true, "type": "array", "description": "Types of properties to include", "items": { "type": "string", "enum": [ "single-family", "multi-family", "condos-townhouses", "land" ], "enumTitles": [ "Single Family", "Multi Family", "Condos/Townhouses", "Land" ] }, "default": [ "single-family", "multi-family", "condos-townhouses", "land" ] }, "buying_types": { "title": "Buying Types", "uniqueItems": true, "type": "array", "description": "Types of buying methods to include", "items": { "type": "string", "enum": [ "online", "in_person", "remote_bid", "offer" ], "enumTitles": [ "Online", "In Person", "Remote Bid", "Offer" ] }, "default": [ "online", "in_person", "remote_bid", "offer" ] }, "condition_flags": { "title": "Condition Flags", "uniqueItems": true, "type": "array", "description": "Additional property condition filters", "items": { "type": "string", "enum": [ "Vacant", "Private Tour Available", "Eligible for Financing", "Inspection Contingency Offered" ], "enumTitles": [ "Vacant", "Private Tour Available", "Eligible for Financing", "Inspection Contingency Offered" ] } }, "featured_flags": { "title": "Featured Flags", "uniqueItems": true, "type": "array", "description": "Special property features and categories to filter by", "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", "New Listings", "Ending Soon", "Featured Properties", "Premium Listings", "Verified Properties" ], "enumTitles": [ "Foreclosure Predict", "Hot Foreclosure", "Hot Bank Owned", "Untapped Deals", "Price Drop", "$1 Opening Bid", "Rural Properties", "Now Vacant", "Interior Photos", "Inspection Reports", "New Listings", "Ending Soon", "Featured Properties", "Premium Listings", "Verified Properties" ] } } } }, "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 } } } } } } } } } }