/catawiki/auctions

POST /api/catawiki/auctions

Price: 10 credits

Get one Catawiki auction by id or URL: title, status, start and close times, lot count, categories, curating expert profile, description and the auction's lots as cards with current bid in EUR, USD and GBP.

How to use it

Fetch a Catawiki auction by the auction_id of a lot or a catawiki.com/a/ URL, with the lots it shows. Find open auctions per category with catawiki/categories/auctions.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• auction string required — Catawiki auction id or auction URL (examples: "1263172", "https://www.catawiki.com/en/a/1263172-rolex-watches-auction"; minLength: 1)

Response

• @type string (default: "CatawikiAuction")
• 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
• description string nullable
• expert object nullable
  • @type string (default: "CatawikiAuctionExpert")
  • id string required
  • name string nullable
  • url string nullable
  • expertise string nullable
  • gender string nullable
  • info string nullable
  • quote string nullable
  • usps array (default: [])
  • image string nullable
  • category object nullable
    • @type string (default: "CatawikiCategoryRef")
    • id string required
    • name string nullable
    • url string nullable
    • level integer nullable
  • category_auction_count integer nullable
• lots array (default: [])
  • @type string (default: "CatawikiLotCard")
  • id string required
  • subtitle string nullable
  • url string nullable
  • image string nullable
  • thumbnail string nullable
  • auction_id string nullable
  • favorite_count integer nullable
  • has_reserve_price boolean nullable
  • has_free_shipping boolean nullable
  • is_explicit_content boolean nullable
  • buy_now_price_eur number nullable
  • seller_name string nullable
  • seller_country_code string nullable
  • bidding_start_at integer nullable
  • bidding_end_at integer nullable
  • current_bid object nullable
    • @type string (default: "CatawikiAmount")
    • eur number nullable
    • usd number nullable
    • gbp number nullable
  • is_reserve_price_met boolean nullable
  • is_closed boolean nullable
  • is_buy_now_available boolean nullable
  • highest_bidder_token string nullable
  • winner_token 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 Catawiki auction 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.