Live order book
Query current bid and ask levels, best prices, and the mid-price for a trading object.
Available data
- Returns
- Current bid and ask levels, best prices, and the mid-price for a trading object
- Market coverage
- Crypto and US and Hong Kong equities; equities return top-of-book only
- Query granularity
- One listing per query; crypto may return multiple depth levels, while equity sizes may be unavailable
Authentication
Query Parameters
Provide at least one of listing_id, asset_id, query, or base.
listing_idstringqueryExamplelisting_gate_BTC_USDT_spotconditionalCanonical listing identifier
asset_idstringqueryExampleasset_btcconditionalCanonical asset identifier
querystringqueryExampleBTCconditionalSearch text used to resolve the query object
tickerstringqueryExampleBTCconditionalTicker alias of query.
symbolstringqueryExampleBTCconditionalSymbol alias of query.
basestringqueryExampleBTCconditionalBase asset code of the trading pair
Equities require market; crypto defaults to gate / spot / USDT.
Market of the query object
venuestringqueryExamplegateoptionalTrading venue code to query
Type of traded product
quotestringqueryExampleUSDToptionalQuote asset code of the trading pair
All optional.
depthintegerqueryExample20optionalNumber of order-book levels requested
Response
best_bidnumberExample64079.8Current highest bid price
best_asknumberExample64079.9Current lowest ask price
mid_pricenumberExample64079.850000000006Midpoint of the best bid and best ask
spread_bpsnumberExample0.01560552966315383Bid-ask spread in basis points
bids[]array[[string, string]]Bid order-book levels
asks[]array[[string, string]]Ask order-book levels
snapshot_timedatetimeExample2026-08-17T17:07:12.671404874ZSource snapshot time for the order book
Availability of the business data
Response status and resolution information
Availability of the business data
actual_taskstringTask that was actually executed
route_reasonstringReason the task or object was selected
limitations[]string[]Known data limitations
updated_atdatetime | stringExample2026-08-17T17:07:12ZMost recent object or response update time
partialbooleanWhether the response contains only a subset of fields
resolution_reasonstringReason code for the object-resolution outcome
Unified object references
Object reference type
idstringExampleasset_btcCanonical object identifier
entity_idstringCanonical entity identifier
asset_idstringExampleasset_btcCanonical asset identifier
listing_idstringCanonical listing identifier
instrument_idstringCanonical financial instrument identifier
venue_idstringCanonical trading venue identifier
event_refstringRelated event identifier
market_idstringCanonical market object identifier
venuestringRelated platform code
resolved_fromstringExampleasset_entityInput used to resolve the object
resolution_confidencestringExampleresolvedObject resolution confidence