HiBid auction catalog
A HiBid auction and one page of its catalog: name, description, status, lot and open-lot counts, bidding open and close times, event dates, bid type, buyer's premium, bid increments, shipping and pickup, payment, terms, location, accepted cards and the auction house (name, city, state, website), then 25 lots per page with the search filters and sorts, and category facets. Pass id, url, or q with latest=true (the auction of the first current search result).
Every response includes credits_used: the credits this call cost.
Parameters
| name | type | description |
|---|---|---|
id | string | Auction id (auction.id of a lot, or the number in a hibid.com/catalog/... link). |
url | string | Instead of id: a hibid.com/catalog/... link. |
q | string | Search words: with latest=true the auction of the first current search result; otherwise searches within the auction's lots. Example: coins |
latest | string | true: use the auction of the first search result for q. Example: true |
zip | string | Near this US or Canadian ZIP / postal code. |
miles | integer | Distance from zip in miles (needs zip). |
status | open | closing_today | hot | all | Lot status (default: open and upcoming). |
type | online | webcast | absentee | listing | Auction type. |
min_bid | number | Lowest minimum bid (the amount the next bid must reach). |
max_bid | number | Highest minimum bid (the amount the next bid must reach). |
shipping | boolean | true: only lots with shipping offered. |
country | string | Country name, e.g. United States or Canada. |
state | string | Two-letter state or province code, e.g. NY. |
sort | no_order | time_left | lot_number | sale_order | newly_added | bid_amount_high_to_low | bid_amount_low_to_high | bid_count_high_to_low | bid_count_low_to_high | distance_nearest | view_count_high_to_low | watch_count_high_to_low | hot_rank | Order. |
page | integer | Result page (1 = first). Example: 1 |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/hibid/v1/auction" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/hibid/v1/auction",
params={},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json() const url = new URL("https://api.api.sh/hibid/v1/auction");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json(); Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).