/invaluable/auctions

POST /api/invaluable/auctions

Price: 5 credits

Get one Invaluable auction (sale catalog) by id or URL: title, description, date and time zone, live, timed or view-only format, sale location, auction house, viewing notes, buyer's premium tiers, bid increments, payment and shipping terms and the conditions of sale.

How to use it

Fetch an auction by the auction_id of a lot or the id from invaluable/auctions/search; list its lots with invaluable/auctions/lots.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• auction string required — Invaluable auction id or auction URL (examples: "MPDF9BGRMX", "https://www.invaluable.com/catalog/0EAM1E3L06"; minLength: 1)

Response

• @type string (default: "InvaluableAuction")
• id string required
• numeric_id string nullable
• url string nullable
• alias string nullable
• description string nullable
• starts_at integer nullable
• local_starts_at string nullable
• timezone string nullable
• is_live boolean nullable
• is_timed boolean nullable
• is_view_only boolean nullable
• is_upcoming boolean nullable
• is_in_progress boolean nullable
• timed_type string nullable
• timed_value integer nullable
• viewing_notes string nullable
• display_notes string nullable
• image string nullable
• thumbnail string nullable
• watcher_count integer nullable
• has_featured_lots boolean nullable
• is_video_enabled boolean nullable
• is_payment_processing_enabled boolean nullable
• is_dynamic_pricing_enabled boolean nullable
• is_premium_included_in_results boolean nullable
• is_parity_banner_displayed boolean nullable
• is_house_fee_step_active boolean nullable
• location object nullable
  • @type string (default: "InvaluableLocation")
  • name string nullable
  • facility_name string nullable
  • street string nullable
  • city string nullable
  • state string nullable
  • state_code string nullable
  • province string nullable
  • postal_code string nullable
  • country string nullable
  • country_code string nullable
  • phone string nullable
  • fax string nullable
  • email string nullable
  • timezone string nullable
  • latitude number nullable
  • longitude number nullable
  • is_primary boolean nullable
  • is_auctioneer_license_required boolean nullable
• auction_house object nullable
  • @type string (default: "InvaluableAuctionHouseSummary")
  • id string nullable
  • numeric_id string nullable
  • name string nullable
  • alias string nullable
  • since_year integer nullable
  • website_url string nullable
  • image string nullable
• buyers_premiums array (default: [])
  • @type string (default: "InvaluableBuyersPremium")
  • label string nullable
  • rate number nullable
  • amount_from number nullable
  • amount_to number nullable
• bid_increments array (default: [])
  • @type string (default: "InvaluableBidIncrement")
  • label string nullable
  • increment number nullable
  • amount_from number nullable
  • amount_to number nullable
• terms array (default: [])
  • @type string (default: "InvaluableTerm")
  • type_code string nullable
  • text string nullable
• conditions_of_sale object nullable
  • @type string (default: "InvaluableTerm")
  • type_code string nullable
  • text string nullable
• payment_methods string nullable
• shipping_terms string nullable
• accepted_cards array (default: [])

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 Invaluable auction exists at this id or URL. 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.