/liveauctioneers/catalogs/lots

POST /api/liveauctioneers/catalogs/lots

Price: 20 credits

List the lots of one LiveAuctioneers auction catalog, optionally narrowed by keyword, in lot-number, estimate or bid-count order. Returns lot cards with estimates, current bid or sold price, bid count, images and lot location.

How to use it

Pass a catalog id from liveauctioneers/catalogs/search or liveauctioneers/auctioneers/auctions. Lots of a finished catalog carry sale_price when sold and is_passed when not.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• catalog string required — LiveAuctioneers catalog id or catalog URL (examples: "430983", "https://www.liveauctioneers.com/catalog/430983_fine-asian-antiques-and-works-of-art-day-1/"; minLength: 1)
• keyword string nullable — Search text within the catalog (examples: "vase"; minLength: 1)
• sort string — Result order (default: "lot_number"; one of: "lot_number", "lot_number_desc", "lowest_estimate", "highest_estimate", "fewest_bids", "most_bids")
• count integer required — Max number of lots to return (min: 1)

Response

• @type string (default: "LiveAuctioneersLot")
• id string required
• url string nullable
• lot_number string nullable
• short_description string nullable
• images array (default: [])
• catalog_id string nullable
• catalog_title string nullable
• catalog_status string nullable
• catalog_lot_count integer nullable
• currency string nullable
• start_price number nullable
• low_estimate number nullable
• high_estimate number nullable
• market_estimate_low number nullable
• market_estimate_high number nullable
• market_estimate_confidence number nullable
• current_bid number nullable
• sale_price number nullable
• buy_now_price number nullable
• buy_now_status string nullable
• bid_count integer nullable
• bid_activity_count integer nullable
• is_sold boolean nullable
• is_passed boolean nullable
• is_available boolean nullable
• is_locked boolean nullable
• is_paused boolean nullable
• is_extended boolean nullable
• is_deleted boolean nullable
• has_reserve boolean nullable
• is_reserve_met boolean nullable
• restricted_categories array (default: [])
• is_promoted boolean nullable
• is_great_find boolean nullable
• is_live_auction boolean nullable
• is_timed_auction boolean nullable
• is_timed_plus_auction boolean nullable
• is_catalog_only boolean nullable
• sale_start_at integer nullable
• sale_end_estimated_at integer nullable
• lot_end_estimated_at integer nullable
• has_free_shipping boolean nullable
• has_free_local_pickup boolean nullable
• has_in_house_shipping boolean nullable
• has_live_shipping boolean nullable
• has_flat_rate_shipping boolean nullable
• flat_rate_shipping_amount number nullable
• location object nullable
  • @type string (default: "LiveAuctioneersLocation")
  • city string nullable
  • region string nullable
  • postal_code string nullable
  • country_code string nullable
• seller object nullable
  • @type string (default: "LiveAuctioneersLotSeller")
  • id string required
  • name string nullable
  • url string nullable
  • city string nullable
  • state_code string nullable
  • country_code string nullable
  • image string nullable
  • rating number nullable
  • review_count integer nullable
  • is_top_rated boolean nullable
• winning_bidder_id string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No LiveAuctioneers catalog with lots exists at this id. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.