{ "openapi": "3.0.1", "info": { "title": "HiBid Auction Scraper - Lots, Bid History & Auction Results", "description": "Extract HiBid auction lots with current bids, the public bid ledger and hammer prices from the archive, plus full auction terms and auction-house contact details. Also returns auction events and HiBid's auction-house directory. No login, no API key, no proxy.", "version": "0.1", "x-build-id": "ljMCjkZY5oUeCipy8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~hibid-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~hibid-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~hibid-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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": { "mode": { "title": "What to scrape", "enum": [ "lots", "auctions", "auctioneers" ], "type": "string", "description": "Lots returns one row per item. Auctions returns one row per sale event. Auction houses returns HiBid's company directory with contact details.", "default": "lots" }, "searchText": { "title": "Search term", "type": "string", "description": "Keyword matched by HiBid against lot titles and descriptions, for example \"john deere\" or \"rolex\". Leave empty to take everything the other filters allow." }, "archive": { "title": "Search the archive (past auctions)", "type": "boolean", "description": "Off searches live auctions. On searches HiBid's archive of closed lots, which is where realized prices live. The date window below only applies when this is on.", "default": false }, "status": { "title": "Lot status", "enum": [ "OPEN", "CLOSING", "CLOSED", "HOT", "TOP", "FEATURED", "ALL" ], "type": "string", "description": "Leave empty and it follows the archive switch: open lots on a live search, closed lots in the archive. OPEN is currently biddable, CLOSING is ending soon, CLOSED is finished. HOT, TOP and FEATURED are HiBid's own promoted sets. Setting OPEN together with the archive returns almost nothing, because the two contradict each other." }, "lotType": { "title": "Bidding format", "enum": [ "ALL", "ONLINE", "WEBCAST", "ABSENTEE", "BIDDABLE", "LISTING" ], "type": "string", "description": "ONLINE is internet-only bidding, WEBCAST is a live-streamed sale, ABSENTEE takes bids ahead of a floor auction, LISTING is catalogue-only with no online bidding.", "default": "ALL" }, "category": { "title": "Category", "type": "string", "description": "A HiBid category name or numeric id, for example \"Coins & Currency\", \"Men's Watches\" or 40265. Matched against HiBid's live category tree (18 top-level categories, hundreds of subcategories) and rejected if unknown, because HiBid silently ignores an unknown id and returns everything." }, "lotUrls": { "title": "Exact lot URLs", "type": "array", "description": "Fetch these lots and skip discovery entirely. Accepts a full https://hibid.com/lot/ URL or a bare numeric lot id.", "items": { "type": "string" } }, "auctionIds": { "title": "Scope to specific auctions", "type": "array", "description": "Walk every lot in these auctions. Accepts a https://hibid.com/auction/ URL or a bare id. This is the only way past HiBid's 10,000-result ceiling on an open search.", "items": { "type": "string" } }, "auctioneerName": { "title": "Auction house name", "type": "string", "description": "Only used in Auction houses mode. Partial names match." }, "state": { "title": "State or province", "type": "string", "description": "Two-letter code, for example TX, CA or ON. Matched against the auction's location, not the bidder's." }, "countryName": { "title": "Country", "enum": [ "United States", "Canada" ], "type": "string", "description": "Full country name as HiBid writes it: \"United States\" or \"Canada\"." }, "zip": { "title": "Near this ZIP code", "type": "string", "description": "US ZIP or Canadian postal code to measure distance from. Pair it with the radius below." }, "miles": { "title": "Radius in miles", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How far from the ZIP code to search. Only works together with a ZIP code. To get the distance back as a field, sort by \"Nearest first\" — HiBid only computes it for that sort." }, "shippingOffered": { "title": "Only lots that ship", "type": "boolean", "description": "Keeps only lots whose auction offers shipping, dropping pickup-only sales.", "default": false }, "closedAfter": { "title": "Closed after", "type": "string", "description": "ISO date, for example 2026-01-01. Archive only — HiBid ignores this on a live search." }, "closedBefore": { "title": "Closed before", "type": "string", "description": "ISO date, for example 2026-08-01. Archive only — HiBid ignores this on a live search." }, "minCurrentBid": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Keeps lots at or above this amount. Compares the realized price when the lot has sold, otherwise the current high bid." }, "maxCurrentBid": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Keeps lots at or below this amount, using the same price as the minimum." }, "minBidCount": { "title": "Minimum number of bids", "minimum": 0, "type": "integer", "description": "Keeps only lots that already attracted at least this many bids." }, "onlyWithBids": { "title": "Only lots with at least one bid", "type": "boolean", "description": "Drops lots nobody has bid on yet.", "default": false }, "onlyWithRealizedPrice": { "title": "Only lots with a realized price", "type": "boolean", "description": "Keeps only lots whose hammer price the auctioneer uploaded. Use with the archive for a clean sold-price comp set.", "default": false }, "onlyWithImages": { "title": "Only lots with photos", "type": "boolean", "description": "Drops lots that carry no picture.", "default": false }, "onlyReserveMet": { "title": "Only lots whose reserve is met", "type": "boolean", "description": "Keeps lots that will actually sell at the current bid.", "default": false }, "excludeKeywords": { "title": "Exclude these words", "type": "array", "description": "Drops a lot when its title or description contains any of these, for example \"replica\", \"parts only\", \"damaged\".", "items": { "type": "string" } }, "includeDescription": { "title": "Include the lot description", "type": "boolean", "description": "The seller's description text for the lot. Comes back with the search, so it costs no extra request.", "default": false }, "includeCategory": { "title": "Include the category breadcrumb", "type": "boolean", "description": "Category id, name, full path, category URL and the root-to-leaf breadcrumb. Costs one extra request per lot.", "default": false }, "includeAllImages": { "title": "Include every photo", "type": "boolean", "description": "The complete list of photo URLs instead of just the lead image already in the base row. Costs one extra request per lot, shared with the category block.", "default": false }, "includeBidHistory": { "title": "Include the bid history", "type": "boolean", "description": "HiBid's public bid ledger: every bid amount and timestamp, plus unique bidders and first and last bid times. Costs one extra request per lot.", "default": false }, "includeRealizedPrice": { "title": "Include the realized price", "type": "boolean", "description": "The hammer price an archived lot sold for, with quantity sold and price per each. Comes back with the search, so it costs no extra request. Around half of archived lots carry one.", "default": false }, "includeAuctionTerms": { "title": "Include the auction terms", "type": "boolean", "description": "Terms and conditions, payment info, shipping and pickup info, the bid increment table, accepted cards and the registration type. Costs one extra request per auction, cached across every lot in it.", "default": false }, "includeAuctioneerContact": { "title": "Include auction house contact details", "type": "boolean", "description": "The auction house phone, email, postal address and website. Costs one extra request per auction, shared with the auction terms block.", "default": false }, "sortBy": { "title": "Sort order", "enum": [ "NO_ORDER", "TIME_LEFT", "NEWLY_ADDED", "LOT_NUMBER", "SALE_ORDER", "HOT_RANK", "LAST_BID", "BID_AMOUNT_HIGH_TO_LOW", "BID_AMOUNT_LOW_TO_HIGH", "BID_COUNT_HIGH_TO_LOW", "BID_COUNT_LOW_TO_HIGH", "MAX_BID_HIGH_TO_LOW", "MAX_BID_LOW_TO_HIGH", "VIEW_COUNT_HIGH_TO_LOW", "VIEW_COUNT_LOW_TO_HIGH", "WATCH_COUNT_HIGH_TO_LOW", "WATCH_COUNT_LOW_TO_HIGH", "DISTANCE_NEAREST", "PENDING_BIDS" ], "type": "string", "description": "How HiBid orders results before the Actor takes them. NO_ORDER is fastest. In Auctions mode only NO_ORDER and DISTANCE_NEAREST apply.", "default": "NO_ORDER" }, "sortDirection": { "title": "Sort direction", "enum": [ "DESC", "ASC" ], "type": "string", "description": "Descending or ascending, applied to the sort order above. For \"Nearest first\" use ascending to get the closest lots.", "default": "DESC" }, "maxItems": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "Ceiling on rows written. Not a target: a narrow filter returns fewer. Free Apify plans are capped at 100.", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Off by default. HiBid answers plain anonymous requests, so a proxy costs money without adding anything. Turn it on only if your runs start getting rate-limited.", "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 } } } } } } } } } }