{ "openapi": "3.0.1", "info": { "title": "SurplusLead AI - GovDeals & Surplus Auction Tracker", "description": "Multi-platform government surplus liquidation & auction sniper. Tracks live lots, bids, closing times, and sends instant Discord/Telegram alerts.", "version": "1.0", "x-build-id": "Dd3kNixnzZOEIez4g" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_studio~govdeals-surplus-auction-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_studio-govdeals-surplus-auction-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/automation_studio~govdeals-surplus-auction-scraper/runs": { "post": { "operationId": "runs-sync-automation_studio-govdeals-surplus-auction-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/automation_studio~govdeals-surplus-auction-scraper/run-sync": { "post": { "operationId": "run-sync-automation_studio-govdeals-surplus-auction-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": { "searchKeyword": { "title": "Search Keyword", "type": "string", "description": "Keywords to search for (e.g., 'truck', 'forklift', 'macbook', 'generator', 'chevy', 'dodge', 'trailer').", "default": "truck" }, "auctionPlatform": { "title": "Auction Source", "enum": [ "all", "gsa_federal", "municipal_surplus" ], "type": "string", "description": "Select specific government auction source or aggregate across all platforms simultaneously.", "default": "all" }, "category": { "title": "Category", "enum": [ "all", "vehicles", "heavy_equipment", "computers_electronics", "confiscated_jewelry" ], "type": "string", "description": "Filter by specific surplus category.", "default": "all" }, "stateFilter": { "title": "Filter by US State (Optional)", "type": "string", "description": "Optional 2-letter US state abbreviation (e.g. 'CA', 'TX', 'FL', 'NY'). Leave blank for all nationwide auctions." }, "maxCurrentBid": { "title": "Max Current Bid ($ USD)", "minimum": 0, "type": "integer", "description": "Maximum current bid ceiling (e.g. 5000). Set to 0 to include auctions at any price.", "default": 0 }, "onlyEndingSoon": { "title": "Ending Soon (< 24 Hours)", "type": "boolean", "description": "Only return auctions closing within the next 24 hours (prime snipe opportunities).", "default": false }, "onlyReserveMet": { "title": "Reserve Met Only (Guaranteed to Sell)", "type": "boolean", "description": "Only return lots where the seller reserve has been met or that have 'No Reserve'.", "default": false }, "maxLots": { "title": "Max Auction Lots to Extract", "minimum": 5, "maximum": 500, "type": "integer", "description": "Maximum number of matching auction lots to extract into the dataset.", "default": 50 }, "discordWebhookUrl": { "title": "Discord Webhook URL (Optional)", "type": "string", "description": "Paste your Discord Channel Webhook URL to receive instant visual alert cards with lot photos, current bid, and direct bid link." }, "telegramBotToken": { "title": "Telegram Bot Token (Optional)", "type": "string", "description": "Optional Telegram Bot Token from @BotFather for mobile deal alerts." }, "telegramChatId": { "title": "Telegram Chat ID (Optional)", "type": "string", "description": "Optional Telegram Chat or Channel ID where alerts should be sent." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Direct high-speed connection is used by default for official US Government auction databases. Apify proxy is optional for municipal portals.", "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 } } } } } } } } } }