{ "openapi": "3.0.1", "info": { "title": "Public Surplus Scraper", "description": "Scrape Public Surplus - government and municipal surplus auctions. Search by keyword, browse by category/region, filter by price and closing window, or fetch full auction details by ID.", "version": "1.0", "x-build-id": "crx7vwvwBS1PMrwpu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~public-surplus-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-public-surplus-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/crawlerbros~public-surplus-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-public-surplus-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/crawlerbros~public-surplus-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-public-surplus-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", "byAuctionIds" ], "type": "string", "description": "What to fetch.", "default": "search" }, "keyword": { "title": "Keyword", "type": "string", "description": "Free-text keyword to search auction titles/descriptions (mode=search). Leave blank to browse by category/region/time filters only." }, "category": { "title": "Category", "enum": [ "", "22", "24", "19", "10", "16", "18", "1", "2", "8", "28", "14", "17", "29", "27", "6", "11", "20", "23", "4", "21", "13", "3", "12", "15", "9", "25", "5", "26" ], "type": "string", "description": "Restrict results to one category (mode=search).", "default": "" }, "region": { "title": "Region (state / province)", "enum": [ "", "al", "ak", "as", "az", "ar", "ca", "co", "ct", "de", "fl", "ga", "gu", "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", "pr", "ri", "sc", "sd", "tn", "tx", "vi", "ut", "vt", "va", "wa", "dc", "wv", "wi", "wy", "ab", "bc", "mb", "nb", "nl", "nt", "ns", "nu", "on", "pe" ], "type": "string", "description": "Restrict results to auctions located in one US state / territory / Canadian province (mode=search).", "default": "" }, "endingWithinHours": { "title": "Auctions ending within", "enum": [ "-1", "1", "6", "24", "120", "240" ], "type": "string", "description": "Only include auctions closing within this window (mode=search).", "default": "-1" }, "startedWithinHours": { "title": "Auctions started within", "enum": [ "-1", "1", "24", "48", "168" ], "type": "string", "description": "Only include auctions that opened within this window (mode=search).", "default": "-1" }, "minPrice": { "title": "Min current price ($)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Drop auctions with a current price below this amount." }, "maxPrice": { "title": "Max current price ($)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Drop auctions with a current price above this amount." }, "sortBy": { "title": "Sort by", "enum": [ "", "id", "title", "timeLeft", "price" ], "type": "string", "description": "Server-side sort order for results (mode=search).", "default": "" }, "sortDescending": { "title": "Sort descending", "type": "boolean", "description": "Reverse the sort order (only applies when Sort by is set).", "default": false }, "auctionIds": { "title": "Auction IDs (mode=byAuctionIds)", "type": "array", "description": "Numeric Public Surplus auction IDs, e.g. `4057251` (from an auction URL `?auc=4057251`).", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on emitted records.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Public Surplus is reachable from Apify datacenter IPs without a proxy; enable only if you experience blocking.", "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 } } }, "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 } } } } } } } } } }