{ "openapi": "3.0.1", "info": { "title": "K-BID Auction Scraper & New-Auction Monitor", "description": "Scrape K-BID (k-bid.com) Midwest online auctions by state, affiliate, ZIP radius, or category, or run on a schedule as a new-auction monitor with Slack/email/webhook alerts.", "version": "0.1", "x-build-id": "P0HTyuTOYt2I9oelh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~k-bid-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-k-bid-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/scrapersdelight~k-bid-scraper/runs": { "post": { "operationId": "runs-sync-scrapersdelight-k-bid-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/scrapersdelight~k-bid-scraper/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-k-bid-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": { "searchType": { "title": "Search type", "enum": [ "all", "state", "affiliate", "zipcode", "category" ], "type": "string", "description": "How to scope the crawl. K-BID filters affiliate/ZIP-radius/category server-side; state is filtered client-side (the site blocks state-path URLs).", "default": "all" }, "states": { "title": "States", "type": "array", "description": "Two-letter state codes to keep, e.g. mn, ia, wi. Applied client-side to the parsed auction location. Used when Search type = By state.", "items": { "type": "string" } }, "affiliateId": { "title": "Affiliate ID", "type": "string", "description": "Restrict to one auction company (K-BID affiliate numeric id) when Search type = By affiliate." }, "zipcode": { "title": "ZIP code", "type": "string", "description": "ZIP center when Search type = By ZIP + radius. Pair with the radius below." }, "radiusMiles": { "title": "Radius (miles)", "type": "integer", "description": "Search radius around the ZIP (distance_radius).", "default": 100 }, "categoryIds": { "title": "Category IDs", "type": "array", "description": "K-BID auction category IDs (auction_categories[]) when Search type = By category.", "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "closing", "published" ], "type": "string", "description": "Result ordering. 'closing' = ending soonest first; 'published' = newest first.", "default": "closing" }, "scrapeItems": { "title": "Scrape individual items (heavy)", "type": "boolean", "description": "Also open each auction's detail page and extract its individual item lots. Much heavier (auctions hold hundreds of items). Leave off for auction-level monitoring.", "default": false }, "maxAuctions": { "title": "Max auctions per run", "minimum": 0, "type": "integer", "description": "Hard cap on auctions scraped this run (0 = unlimited).", "default": 0 }, "monitorMode": { "title": "Monitor mode (new-auction watcher)", "type": "boolean", "description": "Recurring watcher: diff against the prior run's seen auctions (per scope) and output/alert ONLY newly-listed auctions. Pair with an Apify Schedule.", "default": false }, "alertOnNewLot": { "title": "Alert on new auctions", "type": "boolean", "description": "In monitor mode, deliver an alert for each newly-listed auction via the channels below.", "default": true }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "POST endpoint for new-auction alert payloads (Make / Zapier / n8n / custom)." }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Slack incoming-webhook URL for formatted new-auction cards." }, "emailRecipients": { "title": "Email recipients", "type": "array", "description": "Email addresses for the new-auction digest (sent via apify/send-mail).", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. Datacenter rotation is enough for this site.", "default": { "useApifyProxy": true } }, "requestConcurrency": { "title": "Request concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Max parallel requests for item-detail fetches. Keep modest to respect the site.", "default": 4 }, "diagnose": { "title": "Diagnostic mode (dev)", "type": "boolean", "description": "Dev only. Dumps the raw search HTML to the key-value store (DEBUG_SEARCH_HTML) and logs the parsed first auction + pagination check, then exits.", "default": 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 } } } } } } } } } }