/liveauctioneers/catalogs

POST /api/liveauctioneers/catalogs

Price: 5 credits

Get one LiveAuctioneers auction catalog by id or URL: title, status, sale start and end, lot count, currency, buyer's premium tiers, payment and shipping options, sale address, terms of sale, cover lots, bid increments and the auction house.

How to use it

Fetch one auction catalog by numeric id or /catalog/ URL. Use liveauctioneers/catalogs/lots for the lots it contains.

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)

Response

• @type string (default: "LiveAuctioneersCatalogDetail")
• id string required
• url string nullable
• status string nullable
• description string nullable
• preview string nullable
• lot_count integer nullable
• absentee_bidder_count integer nullable
• currency string nullable
• currency_symbol string nullable
• sale_start_at integer nullable
• sale_end_at integer nullable
• sale_end_estimated_at integer nullable
• published_at integer nullable
• is_timed boolean nullable
• is_timed_plus boolean nullable
• is_catalog_only boolean nullable
• has_video boolean nullable
• has_explicit_material boolean nullable
• is_autopay boolean nullable
• is_instant_autopay boolean nullable
• is_escrow_supported boolean nullable
• accepts_ach boolean nullable
• accepts_online_payment boolean nullable
• is_ach_required boolean nullable
• buyers_premium object nullable
  • @type string (default: "LiveAuctioneersBuyersPremium")
  • low_percent number nullable
  • low_cutoff number nullable
  • middle_percent number nullable
  • middle_cutoff number nullable
  • high_percent number nullable
• payment_options array (default: [])
• shipping_options array (default: [])
• ships_to string nullable
• address object nullable
  • @type string (default: "LiveAuctioneersAddress")
  • address string nullable
  • address2 string nullable
  • city string nullable
  • state string nullable
  • postal_code string nullable
  • country_code string nullable
  • country string nullable
  • latitude number nullable
  • longitude number nullable
• seller_id string nullable
• seller object nullable
  • @type string (default: "LiveAuctioneersSellerSummary")
  • id string required
  • name string nullable
  • alias string nullable
  • url string nullable
  • image string nullable
  • address string nullable
  • address2 string nullable
  • city string nullable
  • state_code string nullable
  • state string nullable
  • postal_code string nullable
  • country_code string nullable
  • country string nullable
• cover_lots array (default: [])
  • @type string (default: "LiveAuctioneersCoverLot")
  • id string required
  • image string nullable
• bid_increments array (default: [])
  • @type string (default: "LiveAuctioneersBidIncrement")
  • from_amount number required
  • increment number nullable
• terms string nullable
• custom_terms array (default: [])
  • @type string (default: "LiveAuctioneersCustomTerm")
  • text string nullable
• external_url string nullable
• has_buy_now_items boolean nullable
• has_weapons boolean nullable
• has_free_local_pickup boolean nullable
• has_in_house_shipping boolean nullable
• is_bidder_arranged_shipping boolean 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 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.