{ "openapi": "3.0.1", "info": { "title": "HiBid Scraper — Auction Lots, Bids & Sold Prices", "description": "Scrape HiBid.com auctions in the US and Canada: lot title, description, current bid, bid count, sold price (price realized), images, category, auction dates, location and auctioneer. Search by keyword, category, ZIP/postal radius, state or province, or paste HiBid URLs. No login.", "version": "0.1", "x-build-id": "KutAMXmkaAcVjJVph" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~hibid-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-hibid-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/yugenox~hibid-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-hibid-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/yugenox~hibid-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-hibid-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": { "searchTerms": { "title": "🔎 Search terms", "type": "array", "description": "Keywords to search HiBid lots for, e.g. \"drill\", \"tractor\", \"morgan silver dollar\". Each term is a separate search. Leave empty to browse a category or a location instead.", "items": { "type": "string" } }, "scrapeMode": { "title": "Scrape", "enum": [ "lots", "auctions" ], "type": "string", "description": "Lots (default): one row per auction lot with its bids, price and auction details. Auctions: one row per auction (catalog) with its dates, lot count, location and auctioneer.", "default": "lots" }, "auctionStatus": { "title": "🕒 Status", "enum": [ "open", "closing", "all", "closed" ], "type": "string", "description": "Open: lots you can bid on now plus upcoming ones. Closing soon: lots closing shortly. All current: open plus recently closed lots of current auctions. Closed: past results with the price realized (sold price).", "default": "open" }, "categories": { "title": "🗂️ Categories", "type": "array", "description": "HiBid categories by name (\"Coins & Currency\", \"Tractors\"), full path (\"Construction & Farm - Tractors\"), category URL (https://hibid.com/lots/700006/cars-and-vehicles) or ID. Combined with each search term.", "items": { "type": "string" } }, "startUrls": { "title": "🔗 HiBid URLs", "type": "array", "description": "Any hibid.com lot, catalog (auction), auctioneer (company) or search page. Search filters in the URL (keyword, ZIP, miles, status, category) are kept.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "lotIds": { "title": "🏷️ Lot IDs", "type": "array", "description": "HiBid lot IDs (the number after /lot/ in a lot URL) or lot URLs. Lots that already closed are looked up in the archive, so this also tracks final prices.", "items": { "type": "string" } }, "auctionIds": { "title": "📚 Auction IDs", "type": "array", "description": "HiBid auction (catalog) IDs or URLs. In Lots mode every lot of the auction is scraped; in Auctions mode you get the auction rows.", "items": { "type": "string" } }, "zipOrPostalCode": { "title": "📍 ZIP / postal code", "type": "string", "description": "Only auctions near this US ZIP or Canadian postal code, e.g. \"60601\" or \"M5V 2T6\"." }, "radiusMiles": { "title": "Radius (miles)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Distance from the ZIP / postal code. HiBid's own choices are 25, 50, 100, 250 and 500 miles.", "default": 50 }, "country": { "title": "Country", "enum": [ "any", "United States", "Canada" ], "type": "string", "description": "Only auctions in this country.", "default": "any" }, "stateOrProvince": { "title": "State / province", "type": "string", "description": "Only auctions in this US state or Canadian province, as a code or a name: \"TX\", \"Ontario\", \"BC\"." }, "auctionType": { "title": "Auction type", "enum": [ "all", "online", "webcast", "absentee", "listing", "biddable" ], "type": "string", "description": "Online-only auctions, live auctions with a webcast, absentee-bid auctions, or listings.", "default": "all" }, "shippingOnly": { "title": "Shipping available only", "type": "boolean", "description": "Only lots whose auctioneer offers shipping.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "default", "timeLeft", "newest", "nearest", "highestBid", "lowestBid", "mostBids", "lotNumber" ], "type": "string", "description": "Order of the results. \"Nearest first\" needs a ZIP / postal code.", "default": "default" }, "closedWithinDays": { "title": "Closed in the last (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "For Closed: how far back to look. Ignored when you set the dates below.", "default": 90 }, "closedFrom": { "title": "Closed from", "type": "string", "description": "For Closed: earliest closing date (YYYY-MM-DD)." }, "closedTo": { "title": "Closed to", "type": "string", "description": "For Closed: latest closing date (YYYY-MM-DD). Default: today." }, "soldOnly": { "title": "Only lots with a price realized", "type": "boolean", "description": "For Closed: skip lots whose auctioneer did not publish the sold price. Skipped lots are not charged.", "default": false }, "maxItems": { "title": "Maximum results", "minimum": 0, "type": "integer", "description": "Stop after this many rows in total. 0 = no limit.", "default": 100 }, "maxItemsPerSearch": { "title": "Maximum results per search", "minimum": 0, "type": "integer", "description": "Cap for each search term × category, URL or auctioneer, so one big search can't use up the whole limit. 0 = no cap.", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy (the default) works for HiBid and comes with every Apify plan. If HiBid refuses datacenter IPs, the run switches to residential proxies when your account has them.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages fetched in parallel. The default is fast and gentle on HiBid.", "default": 3 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }