{ "openapi": "3.0.1", "info": { "title": "HiBid Scraper", "description": "Scrape HiBid.com - the #1 live/timed online auction aggregator for grassroots US & Canada farm, equipment, estate, and antiques auctions from thousands of independent auctioneers. Search or browse lots and auctions by category, state, status, and keyword.", "version": "1.0", "x-build-id": "veYlcwjm0iyu2du3s" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~hibid-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~hibid-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~hibid-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "lots", "auctions", "lotDetails", "auctionDetails", "auctioneers" ], "type": "string", "description": "What to fetch.", "default": "lots" }, "searchText": { "title": "Search keyword", "type": "string", "description": "Free-text keyword search (mode=lots/auctions). Searches titles and descriptions.", "default": "tractor" }, "category": { "title": "Category", "enum": [ "", "700001", "40089", "700006", "40118", "700009", "700008", "40196", "40111", "40237", "700004", "40252", "700003", "40060", "700002", "700007", "40391", "40359" ], "type": "string", "description": "Filter by top-level HiBid category (mode=lots/auctions).", "default": "" }, "state": { "title": "State / Province", "enum": [ "", "AL", "AK", "AB", "AS", "AZ", "AR", "AA", "AE", "AP", "BC", "CA", "CO", "CT", "DE", "DC", "FM", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MB", "MH", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NB", "NH", "NJ", "NM", "NY", "NL", "NC", "ND", "MP", "NT", "NS", "NU", "OH", "OK", "ON", "OR", "PW", "PA", "PE", "PR", "QC", "RI", "SK", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY", "YT" ], "type": "string", "description": "Filter to auctions/lots located in a specific US state or Canadian province (mode=lots/auctions/auctioneers).", "default": "" }, "status": { "title": "Auction/lot status", "enum": [ "ALL", "HOT", "TOP", "CLOSING", "FEATURED", "OPEN", "CLOSED" ], "type": "string", "description": "Filter by curated status (mode=lots/auctions).", "default": "ALL" }, "auctionType": { "title": "Auction type", "enum": [ "ALL", "ONLINE", "BIDDABLE", "ABSENTEE", "WEBCAST", "LISTING" ], "type": "string", "description": "Filter by bidding format (mode=lots/auctions).", "default": "ALL" }, "sortOrder": { "title": "Sort order", "enum": [ "LOT_NUMBER", "TIME_LEFT", "NEWLY_ADDED", "HOT_RANK", "BID_COUNT_HIGH_TO_LOW", "BID_COUNT_LOW_TO_HIGH", "MAX_BID_HIGH_TO_LOW", "MAX_BID_LOW_TO_HIGH", "BID_AMOUNT_HIGH_TO_LOW", "BID_AMOUNT_LOW_TO_HIGH", "LAST_BID", "PENDING_BIDS", "SALE_ORDER", "VIEW_COUNT_HIGH_TO_LOW", "VIEW_COUNT_LOW_TO_HIGH", "WATCH_COUNT_HIGH_TO_LOW", "WATCH_COUNT_LOW_TO_HIGH", "DISTANCE_NEAREST", "NO_ORDER" ], "type": "string", "description": "Sort order for lot results (mode=lots only).", "default": "LOT_NUMBER" }, "auctionIds": { "title": "Auction IDs (mode=lots/auctionDetails)", "type": "array", "description": "Scope lot search to one auction (mode=lots, first ID used), or look up full auction details (mode=auctionDetails, all IDs used). Find IDs in HiBid auction URLs, e.g. `hibid.com/auction/755763/...` → `755763`.", "default": [], "items": { "type": "string" } }, "lotIds": { "title": "Lot IDs (mode=lotDetails)", "type": "array", "description": "Look up specific lots by ID (mode=lotDetails). Find IDs in HiBid lot URLs, e.g. `hibid.com/lot/307654532/...` → `307654532`.", "default": [], "items": { "type": "string" } }, "auctioneerName": { "title": "Auctioneer name", "type": "string", "description": "Filter auctioneers/auction houses by name (mode=auctioneers)." }, "zipCode": { "title": "ZIP / postal code", "type": "string", "description": "Center point for a distance radius search (mode=lots/auctions). Use with `milesRadius`." }, "milesRadius": { "title": "Distance radius (miles)", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Only include auctions/lots within this many miles of `zipCode`. Ignored if `zipCode` is empty.", "default": 50 }, "shippingOfferedOnly": { "title": "Shipping offered only", "type": "boolean", "description": "Only include lots/auctions where the auctioneer offers shipping (mode=lots/auctions).", "default": false }, "includeEnded": { "title": "Include ended (archived)", "type": "boolean", "description": "Include closed/ended auctions and lots instead of only currently open ones (mode=lots/auctions).", "default": false }, "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": "HiBid's browse/search API works without any proxy from most datacenter IPs. Leave AUTO on for resilience; no paid proxy group is required.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }