Auctions & Exchange

Exchange Orderbook

Retrieve current bids and offers from the supported self-serve exchange venues or your custom authorized sources.

post/exchange/orderbook

Request

  • Base URL: https://external-api.wine-labs.com
  • URL: https://external-api.wine-labs.com/exchange/orderbook
  • Auth: none declared

Request body

user_idstring uuid required

Authorized user identifier used for plan-based authentication and quota tracking.

querystring

Free-text wine description; optional when identifiers are provided.

lwinstring

Direct LWIN filter.

vintagestring

Vintage filter.

sourcesstring[]

Restrict results to specific exchange sources.

bid_askstring

Use "BID" or "ASK" to return only bids or asks.

formatstring

Bottle format filter.

conditionstring

Condition filter.

packagingstring

Packaging filter.

duty_codestring

Duty status filter (e.g., IB, DP).

currency_codestring

Optional target currency for FX conversion; does not filter order book rows by currency.

limitnumber

Page size (1–500).

offsetnumber

Pagination offset (>= 0).

sort_bystring

Sort options: price, source, bid_ask, volume, currency_code.

sort_directionstring

Sort direction: asc or desc.

Response

Response highlights:

  • limit, offset, count, total_available: pagination metadata.
  • results[]: order book entries with provider identifiers, wine details, side (bid/ask), volume, price, currency, condition, packaging, duty status, and display name.

Notes:

  • Currency inputs convert returned prices only; they never filter which orders are returned.
  • Self-serve exchange plans include bordeaux_index, winebourse, cru_world_wine, cultx, cult_wines, vinovest, bbx, and arvest_wine.
  • Transactions API includes auctions, exchange trades, and exchange order book under one shared allowance. All exchanges except Liv-ex are included. Legacy Exchange Endpoints subscriptions retain their original split allowances.
  • Custom plans are available if you need additional venues, custom scopes, or higher throughput.
object required

Changes

No recorded changes to this operation across all 1 revision of this API.