/invaluable/auction_houses

POST /api/invaluable/auction_houses

Price: 20 credits

Get one Invaluable auction house by id or URL: name, biography, founding year, website, logo, locations with address and contact details, review rating and count, follower count, bidding and payment options, its notable sold lots with prices, its popular upcoming lots, the artists it sells, each with a lot count, and its upcoming auctions.

How to use it

Fetch an auction house by the auction_house_id of a lot or the id from invaluable/auction_houses/search; its finished sales are invaluable/auction_houses/auctions and its reviews invaluable/auction_houses/reviews.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• auction_house string required — Invaluable auction house id or URL (examples: "8RA3GB6FWF", "https://www.invaluable.com/auction-house/abell-auction-8ra3gb6fwf/"; minLength: 1)

Response

• @type string (default: "InvaluableAuctionHouse")
• id string required
• numeric_id string nullable
• url string nullable
• alias string nullable
• name string nullable
• bio string nullable
• since_year integer nullable
• website_url string nullable
• image string nullable
• cover string nullable
• rating number nullable
• review_count integer nullable
• follower_count integer nullable
• connect_type string nullable
• two_factor_setting string nullable
• phone_bidding_setting string nullable
• is_buy_now_enabled boolean nullable
• is_featured_lots_enabled boolean nullable
• is_keyword_alerts_enabled boolean nullable
• is_bid_modal_enabled boolean nullable
• is_bulk_bidding_enabled boolean nullable
• is_bid_cancel_enabled boolean nullable
• is_bid_history_enabled boolean nullable
• is_auto_charge_enabled boolean nullable
• is_ach_disabled boolean nullable
• is_parity_enabled boolean nullable
• is_current_price_hidden boolean nullable
• is_all_in_price_shown boolean nullable
• is_live_price_shown boolean nullable
• is_shipping_enabled boolean nullable
• is_online_payment_enabled boolean nullable
• is_translation_enabled boolean nullable
• is_instant_bidding_enabled boolean nullable
• is_realized_price_shown boolean nullable
• is_single_sign_on boolean nullable
• is_self_categorized boolean nullable
• locations array (default: [])
  • @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
• notable_lots array (default: [])
  • @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
• popular_lots array (default: [])
  • @type string (default: "InvaluablePopularLot")
  • id string required
  • numeric_id string nullable
  • url string nullable
  • lot_number string nullable
  • description string nullable
  • image string nullable
  • estimate_low number nullable
  • estimate_high number nullable
  • current_bid number nullable
  • min_bid number nullable
  • suggested_bid number nullable
  • bid_count integer nullable
  • view_count integer nullable
  • currency string nullable
  • currency_symbol string nullable
  • sale_at integer nullable
  • timezone string nullable
  • is_live boolean nullable
  • is_timed boolean nullable
  • is_view_only boolean nullable
  • is_upcoming boolean nullable
  • is_closed boolean nullable
  • is_sold boolean nullable
  • is_passed boolean nullable
• artists array (default: [])
  • @type string (default: "InvaluableHouseArtist")
  • id string required
  • url string nullable
  • name string nullable
  • image string nullable
  • lot_count integer nullable
• upcoming_auctions array (default: [])
  • @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 house 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.