{ "openapi": "3.0.1", "info": { "title": "US Foreclosures, Tax Deeds & Sheriff Auctions API", "description": "Aggregate county tax deeds, sheriff sales, and government bank REO properties from Bid4Assets, RealAuction, Auction.com, Hubzu, USDA, and HUD into a unified deal flow.", "version": "0.0", "x-build-id": "tfzCXard5iDHCcIWO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/magebase~us-foreclosures-tax-deeds-auctions-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-magebase-us-foreclosures-tax-deeds-auctions-api", "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/magebase~us-foreclosures-tax-deeds-auctions-api/runs": { "post": { "operationId": "runs-sync-magebase-us-foreclosures-tax-deeds-auctions-api", "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/magebase~us-foreclosures-tax-deeds-auctions-api/run-sync": { "post": { "operationId": "run-sync-magebase-us-foreclosures-tax-deeds-auctions-api", "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": { "states": { "title": "Target States", "type": "array", "description": "Two-letter US state codes (e.g. FL, TX, CA, OH, GA).", "default": [ "FL", "TX" ], "items": { "type": "string" } }, "auctionTypes": { "title": "Auction Types", "type": "array", "description": "Filter by auction or distress category.", "items": { "type": "string", "enum": [ "all", "tax-deed", "tax-sale", "foreclosure", "sheriff-sale", "reo" ] }, "default": [ "all" ] }, "minPrice": { "title": "Minimum Starting Bid ($)", "type": "integer", "description": "Filter properties with starting bid above this minimum.", "default": 10000 }, "maxPrice": { "title": "Maximum Starting Bid ($)", "type": "integer", "description": "Filter properties with starting bid below this maximum.", "default": 500000 }, "sources": { "title": "Target Sources (24 US Sources)", "type": "array", "description": "Select specific county auction portals or use ['all'].", "items": { "type": "string", "enum": [ "all", "bid4assets", "realauction", "auction-com", "hubzu", "govdeals", "xome", "usda-properties", "hud-homestore", "fannie-mae", "freddie-mac", "civicsource", "foreclosure-com", "va-properties", "fdic-real-estate", "us-marshals", "irs-treasury-pals", "gsa-real-property", "sri-auctions", "govease", "linebarger-tax-sales", "cook-county-sheriff", "harris-county-tax-sales", "maricopa-sheriff-sales", "la-county-tax-collector" ] }, "default": [ "all" ] }, "maxResults": { "title": "Max Results", "type": "integer", "description": "Maximum number of properties to extract.", "default": 100 }, "deduplicate": { "title": "Deduplicate Multi-Listed Properties", "type": "boolean", "description": "Cluster cross-posted properties across trustee, county, and auction feeds.", "default": true }, "includeRawData": { "title": "Include Raw Data", "type": "boolean", "description": "Include original unmodified scraped payloads in output dataset.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify Proxy settings (datacenter or residential)." } } }, "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 } } } } } } } } } }