/catawiki/categories/auctions

POST /api/catawiki/categories/auctions

Price: 5 credits

List the open Catawiki auctions in a category: title, status, start and close times, lot count, auction type, image and the curating experts.

How to use it

Find the auctions currently open in a Catawiki category, from catawiki/categories. Pass an auction id to catawiki/auctions for its lots.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category_id string required — Catawiki category id or category URL (examples: "333", "https://www.catawiki.com/en/c/343-rolex-watches"; minLength: 1)
• count integer required — Max number of auctions to return (min: 1)

Response

• @type string (default: "CatawikiAuctionSummary")
• id string required
• url string nullable
• status string nullable
• start_at integer nullable
• close_at integer nullable
• closed_at integer nullable
• lot_count integer nullable
• type_id string nullable
• theme_id string nullable
• is_themed boolean nullable
• is_explicit_content boolean nullable
• image string nullable
• promo_images array (default: [])
• categories array (default: [])
  • @type string (default: "CatawikiCategoryRef")
  • id string required
  • name string nullable
  • url string nullable
  • level integer nullable
• auctioneers array (default: [])
  • @type string (default: "CatawikiAuctioneer")
  • id string required
  • name string nullable
  • image string nullable
  • is_profile_complete boolean nullable
• live_stream object nullable
  • @type string (default: "CatawikiLiveStream")
  • campaign_key string nullable
  • status string nullable
  • scheduled_start_at integer nullable
  • started_at integer nullable
  • ended_at integer nullable
  • is_giveaway 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 Catawiki category 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.