/invaluable/auctions/lots

POST /api/invaluable/auctions/lots

Price: 20 credits

List the lots of one Invaluable auction, upcoming or past, in lot-number order, optionally narrowed by a keyword. Lots of a past auction carry their sold prices; lots of an upcoming one carry estimates, current bids and bid counts.

How to use it

Take the auction id from invaluable/auctions/search, invaluable/auction_houses/auctions or a lot's auction_id; pass a lot id to invaluable/lots for the full description.

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: "0EAM1E3L06", "https://www.invaluable.com/catalog/MPDF9BGRMX"; minLength: 1)
• keyword string nullable — Search text within the auction (examples: "tabriz"; minLength: 1)
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "InvaluableLotSummary")
• id string required
• numeric_id string nullable
• url string nullable
• lot_number string nullable
• description string nullable
• details string nullable
• image string nullable
• image_width integer nullable
• image_height integer nullable
• estimate_low number nullable
• estimate_high number nullable
• current_bid number nullable
• reserve_price number nullable
• sold_price number nullable
• bid_count integer nullable
• currency string nullable
• currency_symbol string nullable
• sale_type string nullable
• sale_at integer nullable
• sale_local_time string nullable
• ends_at integer nullable
• listed_at integer nullable
• is_closed boolean nullable
• is_featured boolean nullable
• is_parity boolean nullable
• is_results_posted boolean nullable
• favorite_count integer nullable
• activity_count integer nullable
• supercategory string nullable
• supercategory_id string nullable
• category string nullable
• category_id string nullable
• subcategory string nullable
• subcategory_id string nullable
• category_paths array (default: [])
• house_category string nullable
• house_category_id string nullable
• house_category_path string nullable
• location string nullable
• state string nullable
• country string nullable
• latitude number nullable
• longitude number nullable
• auction_id string nullable
• auction_house_id string nullable
• auction_house_name string nullable
• artist_id string nullable
• artist_name 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 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.