Orderbook

Bid/Ask Metrics

Bid Ask

Endpoint: GET /v2/bidAsk

Description: A bid (or limit buy) is a "passive" buyer who advertises the price and size they would like to buy at. An asks (or limit sell) is a "passive" seller who advertises the price and size they would like to sell at.

Summary: Bid Ask

Bid Ask Ratio

Endpoint: GET /v2/bidAskRatio

Description: Bid Ask Ratio is an oscillator that ranges from -1 to 1. The mathematical formula is (Bids - Asks) / (Bids + Asks).

Summary: Bid Ask Ratio

Bid Ask Delta

Endpoint: GET /v2/bidAskDelta

Description: Evaluate the immediate disparity between buy and sell orders.

Summary: Bid Ask Delta

Bid Ask Ratio Diff

Endpoint: GET /v2/bidAskRatioDiff

Description: Change in orderbook bid ask ratio over a specified period of time.

Summary: Bid Ask Ratio Diff

Bids Ask Spread

Endpoint: GET /v2/bidsAskSpread

Description: The bid-ask spread represents the difference between the best bid (highest price a buyer is willing to pay) and the best ask (lowest price a seller is willing to accept). Tracking the spread provides insights into market liquidity, trading costs, and potential slippage. A narrower spread typically signals higher liquidity and lower transaction costs, while a wider spread can indicate lower liquidity or heightened volatility.

Summary: Bids Ask Spread

Combined Book

Endpoint: GET /v2/combinedBook

Description: A consolidated perspective of the market's orderbook dynamics.

Summary: Combined Book

Best Bid Ask

Endpoint: GET /v2/bestBidAsk

Description: Represents the total limit buy size (best bid) and limit sell size (best ask) at the closest price levels to the last traded price. These are the first executable price levels on each side of the orderbook.

Summary: Best Bid Ask

Orderbook Dynamics

Bids Increase Decrease

Endpoint: GET /v2/bidsIncreaseDecrease

Description: Change in orderbook Bids over a specific time period. The mathematical formula is Current Bid - Previous Bid

Summary: Bids Increase Decrease

Asks Increase Decrease

Endpoint: GET /v2/asksIncreaseDecrease

Description: Change in orderbook Asks over a specific time period. The mathematical formula is Current Ask - Previous Ask

Summary: Asks Increase Decrease

Market Imbalance

Market Imbalance Index

Endpoint: GET /v2/marketImbalanceIndex

Description: A proprietary Hyblock indicator that combines orderflow (aggressive volume) and orderbook (passive liquidity) imbalances to quantify overall market pressure. The index oscillates between -1 and 1, indicating net sell pressure or buy side pressure. Positive values indicate net demand dominance. Negative values indicate net supply side dominance.

Summary: Market Imbalance Index

Common Parameters

Most endpoints accept the following common query parameters:

exchange: Exchange identifier (e.g., binance_perp_stable)

coin: Cryptocurrency symbol (e.g., BTC, ETH)

timeframe: Time interval (1m, 5m, 15m, 1h, 4h, 1d)

limit: Number of data points to return (default: 50)

startTime: Start timestamp (Unix timestamp)

endTime: End timestamp (Unix timestamp)

sort: Sort order (asc or desc)

Authentication

All endpoints require authentication via:

API Key: x-api-key header

OAuth2: Bearer token

Rate Limits

Rate Limit: 10 requests per second

Burst Limit: 20 concurrent requests

Base URL

All endpoints are prefixed with /v2/ and should be accessed via the base API URL.

Table of Contents#

Bid/Ask Metrics#

Bid Ask#

Bid Ask Ratio#

Bid Ask Delta#

Bid Ask Ratio Diff#

Bids Ask Spread#

Combined Book#

Best Bid Ask#

Orderbook Dynamics#

Bids Increase Decrease#

Asks Increase Decrease#

Market Imbalance#

Market Imbalance Index#

Common Parameters#

Authentication#

Rate Limits#

Base URL#

Table of Contents