# Hyblock API (Dev)
## API Docs
- Auth [auth_token](https://doc.dev.hyblockcapital.com/auth-token-25773980e0.md):
- Orderflow [Kline](https://doc.dev.hyblockcapital.com/kline.md): Candlestick price chart data. Open is the first price during the time period (candle), high is the highest price, low is the lowest price, and close is the last price.
- Orderflow [Exchange Premium](https://doc.dev.hyblockcapital.com/exchange-premium-25773444e0.md): Shows the price difference of an asset between two or more exchanges. This metric is useful for identifying arbitrage opportunities and understanding market inefficiencies.
- Orderflow [Buy volume](https://doc.dev.hyblockcapital.com/buy-volume-25773445e0.md): Aggregates the volume from market buy orders, summing the size of every market order on the buy side to reflect buying pressure.
- Orderflow [Sell volume](https://doc.dev.hyblockcapital.com/sell-volume-25773446e0.md): Aggregates the volume from market sell orders, summing the size of every market order on the sell side to reflect sell ing pressure.
- Orderflow [Volume delta](https://doc.dev.hyblockcapital.com/volume-delta-25773447e0.md): Calculates the difference between buy and sell volume, revealing which side (buy or sell) holds dominance in the market.
- Orderflow [Volume ratio](https://doc.dev.hyblockcapital.com/volume-ratio-25773448e0.md): Measures the ratio of buy-side traded volume to sell-side traded volume. It provides insight into the strength of buying versus selling pressure in the market.
- Orderflow [Bot Tracker](https://doc.dev.hyblockcapital.com/bot-tracker-25773449e0.md): This indicator detects potential bot activity by tracking unique order sizes that repeat frequently within short time frames. For instance, if a market order of size $57,889 appears five times in one minute, it is flagged as bot activity.
- Orderflow [Slippage](https://doc.dev.hyblockcapital.com/slippage-25773450e0.md): Slippage is the difference between the expected price of a trade and the actual price at which the trade is executed, which can occur due to delays or insufficient liquidity in the market.
- Orderflow [Transfer Of Contracts](https://doc.dev.hyblockcapital.com/transfer-of-contracts-25773451e0.md): This metric captures the absolute difference between volume and open interest, highlighting the volume involved in contract transfers that do not alter the net open interest.
- Orderflow [Participation Ratio](https://doc.dev.hyblockcapital.com/participation-ratio-25773452e0.md): This metric indicates the percentage of volume attributed to net position openings by dividing OI Delta by Volume, showing the share of total volume represented by open interest changes.
- Orderflow [Market Order Count](https://doc.dev.hyblockcapital.com/market-order-count-25773453e0.md): This indicator measures the count (number) of market orders executed for a specific ticker within a set time period, providing insights into aggressive buying or selling pressure.
- Orderflow [Market Order Average Size](https://doc.dev.hyblockcapital.com/market-order-average-size-25773454e0.md): This metric calculates the average size of market orders for a given ticker over a specified time period or candle, providing insight into typical market order size during that interval.
- Orderflow [Limit Order Count](https://doc.dev.hyblockcapital.com/limit-order-count-25773455e0.md): This indicator measures the count (number) of limit orders executed for a specific ticker within a set time period, providing insights into passive buying or selling pressure.
- Orderflow [Limit Order Average Size](https://doc.dev.hyblockcapital.com/limit-order-average-size-25773456e0.md): This metric calculates the average size of limit orders for a given ticker over a specified time period or candle, providing insight into typical limit order size during that interval.
- Orderflow [Buy Sell Trade Count Ratio](https://doc.dev.hyblockcapital.com/buy-sell-trade-count-ratio-25773457e0.md): Represents the ratio of the number of buy trades to sell trades within a specified time frame. This metric helps gauge market sentiment by showing whether buying or selling activity dominates.
- Orderflow [Limit Order Count Ratio](https://doc.dev.hyblockcapital.com/limit-order-count-ratio-25773458e0.md): Calculates the normalized imbalance between limit buy and limit sell orders for a given symbol and exchange within a specified time range. This ratio indicates whether buying or selling pressure dominates in the limit order book.
- Orderflow [Market Order Count Ratio](https://doc.dev.hyblockcapital.com/market-order-count-ratio-25773459e0.md): Computes the normalized imbalance between market buy and market sell orders for a given symbol and exchange within a specified time range. This ratio reflects aggressive trading sentiment.
- Orderflow [Previous Day Level](https://doc.dev.hyblockcapital.com/previous-day-level-25773460e0.md): Tracks key technical levels from the previous day (UTC). These key levels are previous day high, previous day low, previous day open, and previous day equilibrium (which is the average of high and low).
- Orderflow [Previous Week Level](https://doc.dev.hyblockcapital.com/previous-week-level-25773461e0.md): Tracks key technical levels from the previous week (UTC). These key levels are previous week high, previous week low, previous week open, and previous week equilibrium (which is the average of high and low).
- Orderflow [Previous Month Level](https://doc.dev.hyblockcapital.com/previous-month-level-25773462e0.md): Tracks key technical levels from the previous month (UTC). These key levels are previous month high, previous month low, previous month open, and previous month equilibrium (which is the average of high and low).
- Funding Rate [Funding Rate](https://doc.dev.hyblockcapital.com/funding-rate-25773463e0.md): Periodic payments between long and short traders to make perpetual futures price stay in sync with index (spot) price.
- Longs & Shorts [Top Trader Accounts](https://doc.dev.hyblockcapital.com/top-trader-accounts-25773464e0.md): This measures the total number of top trader accounts that are long (or short). Note, top traders do not necessarily mean the best traders or those with the highest profits, but rather classifies top traders as accounts with the top20% in margin. This indicator is similar to Global Long Accounts with the only difference being that it focuses on the top 20% accounts.
- Longs & Shorts [Top Trader Positions](https://doc.dev.hyblockcapital.com/top-trader-positions-25773465e0.md): This measures the total number of top trader positions that are long (or short). The key difference here is that instead of looking at accounts, it instead looks at positions.
- Longs & Shorts [Global Accounts](https://doc.dev.hyblockcapital.com/global-accounts-25773466e0.md): This measures the total number of accounts that are long or short on given exchange like Binance. So for example, if there are 1million accounts on Binance and 600k of them are net long, then the global accounts long% is 60% (and short% = 40%). Each account gets one 'vote'.
- Longs & Shorts [Net Long Short](https://doc.dev.hyblockcapital.com/net-long-short-25773467e0.md): Estimated net longs and net shorts derived from taker orders & open interest.
- Longs & Shorts [Net Long Short Delta](https://doc.dev.hyblockcapital.com/net-long-short-delta-25773468e0.md): The difference between Net Longs and Net Shorts.
- Longs & Shorts [Whale Retail Delta](https://doc.dev.hyblockcapital.com/whale-retail-delta-25773469e0.md): This is the difference between top trader positions long% ('whales') and global accounts long% ('retail').
- Longs & Shorts [True Retail Long Short](https://doc.dev.hyblockcapital.com/true-retail-long-short-25773470e0.md): This metric shows the percentage of retail accounts in long versus short positions, with each account equally contributing one vote, regardless of position size.
- Longs & Shorts [Whale Position Dominance](https://doc.dev.hyblockcapital.com/whale-position-dominance-25773471e0.md): Evaluates the influence of larger positions in the market compared to broader account-level sentiment among prominent traders. Offers insights into whether larger positions are exerting outsized influence on the market relative to the overall positioning of significant accounts. Serves as a proxy for whale activity, helping users understand how concentrated larger positions are and whether they align with broader sentiment trends.
- Longs & Shorts [Trader Sentiment Gap](https://doc.dev.hyblockcapital.com/trader-sentiment-gap-25773472e0.md): Highlights the sentiment divergence between larger, more influential accounts and smaller retail accounts. Provides a measure of how positioning sentiment differs between these two groups, offering insights into whether they are aligned or moving in opposite directions. Helps identify potential behavioral patterns across different trader segments, revealing shifts in market sentiment that may not be immediately apparent from broader metrics.
- Orderbook [Bid Ask](https://doc.dev.hyblockcapital.com/bid-ask-25773473e0.md): 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.
- Orderbook [Bid Ask Ratio](https://doc.dev.hyblockcapital.com/bid-ask-ratio-25773474e0.md): Bid Ask Ratio is an oscillator that ranges from -1 to 1. The mathematical formula is (Bids - Asks) / (Bids + Asks).
- Orderbook [Bid Ask Delta](https://doc.dev.hyblockcapital.com/bid-ask-delta-25773475e0.md): Evaluate the immediate disparity between buy and sell orders.
- Orderbook [Bid Ask Ratio Diff](https://doc.dev.hyblockcapital.com/bid-ask-ratio-diff-25773476e0.md): Change in orderbook bid ask ratio over a specified period of time.
- Orderbook [Bids Ask Spread](https://doc.dev.hyblockcapital.com/bids-ask-spread-25773477e0.md): 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.
- Orderbook [Combined Book](https://doc.dev.hyblockcapital.com/combined-book-25773478e0.md): A consolidated perspective of the market's orderbook dynamics.
- Orderbook [Bids Increase Decrease](https://doc.dev.hyblockcapital.com/bids-increase-decrease-25773479e0.md): Change in orderbook Bids over a specific time period. The mathematical formula is Current Bid - Previous Bid
- Orderbook [Asks Increase Decrease](https://doc.dev.hyblockcapital.com/asks-increase-decrease-25773480e0.md): Change in orderbook Asks over a specific time period. The mathematical formula is Current Ask - Previous Ask
- Orderbook [Best Bid Ask](https://doc.dev.hyblockcapital.com/best-bid-ask-25773481e0.md): Returns the current highest bid price and lowest ask price available in the market. These values represent the most competitive prices for buying and selling an asset.
- Orderbook [Market Imbalance Index](https://doc.dev.hyblockcapital.com/market-imbalance-index-25773482e0.md): Indicates the degree of imbalance between buy and sell orders in the order book. A higher index suggests strong directional bias, while a lower index indicates a more balanced market.
- Global Metrics [Global Bid Ask](https://doc.dev.hyblockcapital.com/global-bid-ask-25773483e0.md): Returns aggregated bid and ask volume across all/selected exchanges.
- Global Metrics [Global Bid Ask Ratio](https://doc.dev.hyblockcapital.com/global-bid-ask-ratio-25773484e0.md): Returns the ratio of total bid volume to ask volume across all/selected exchanges.
- Global Metrics [Global Combined Book](https://doc.dev.hyblockcapital.com/global-combined-book-25773485e0.md): Returns a merged order book from all exchanges.
- Global Metrics [Global Bid Ask Delta](https://doc.dev.hyblockcapital.com/global-bid-ask-delta-25773486e0.md): Returns the difference (delta) between total bid and ask volumes across all/selected exchanges.
- Global Metrics [Global Bid Ask Ratio Increase Decrease](https://doc.dev.hyblockcapital.com/global-bid-ask-ratio-increase-decrease-25773487e0.md): Returns the change in bid-ask ratio for each candle (data point) compared to its previous candle, based on the selected timeframe. This helps track momentum shifts and market sentiment changes over time across all or selected exchanges. (e.g., increasing bid-ask ratio may indicate growing buying pressure).
- Global Metrics [Global Bids Increase Decrease](https://doc.dev.hyblockcapital.com/global-bids-increase-decrease-25773488e0.md): Returns the change in total bid volume for each candle compared to its previous candle, based on the selected timeframe. This helps identify whether buying pressure is increasing or decreasing across exchanges and market types.
- Global Metrics [Global Asks Increase Decrease](https://doc.dev.hyblockcapital.com/global-asks-increase-decrease-25773489e0.md): Returns the change in total ask volume for each candle compared to its previous candle, based on the selected timeframe. This helps identify whether selling pressure is increasing or decreasing across exchanges and market types.
- Open Interest [Open Interest](https://doc.dev.hyblockcapital.com/open-interest-25773490e0.md): Open Interest (OI) is the contracts (or positions) open (or outstanding) in the market.
- Open Interest [Open Interest Delta](https://doc.dev.hyblockcapital.com/open-interest-delta-25773491e0.md): Change in open interest over a specific time period.
- Options [Bvol](https://doc.dev.hyblockcapital.com/bvol-25773492e0.md): Users can use Binance Volatility Inex to gauge market sentiments, improve risk management, and make more informed trading decisions on Binance Options. A high BVOL indicates that significant price changes are anticipated, while a low BVOL suggests minor price fluctuations are expected.
- Options [Dvol](https://doc.dev.hyblockcapital.com/dvol-25773493e0.md): This deribit implied volatility index uses the implied volatility smile of the relevant expiries to output one number that gives a gauge of the 30 day annualised implied volatility. The DVOL is forward-looking volatility. What does the calculated value mean? It gives the 30 day (forward-looking) annualised expectation of volatilit.
- Sentiment [Margin Lending Ratio](https://doc.dev.hyblockcapital.com/margin-lending-ratio-25773494e0.md): This indicator shows the ratio of cumulative data value between BTC/USDT leverage quote currency (USDT) and underlying asset (BTC) over a given period of time.
- Sentiment [Fear And Greed](https://doc.dev.hyblockcapital.com/fear-and-greed-25773495e0.md): The Crypto Fear and Greed Index assigns a score ranging from 0 to 100, which gauges the sentiment surrounding Bitcoin, from extreme fear to extreme greed.
- Sentiment [User Bot Ratio](https://doc.dev.hyblockcapital.com/user-bot-ratio-25773496e0.md): This indicator shows the number of users and bots (via api) connected to Bitmex and the ratio between them.
- Sentiment [Premium P2P](https://doc.dev.hyblockcapital.com/premium-p2p-25773497e0.md): The relative ratio of USDT and USDC relative to the 1:1 USD peg, otherwise known as 'premium', on the Okx peer-to-peer market.
- Sentiment [Leaderboard Notional Profit](https://doc.dev.hyblockcapital.com/leaderboard-notional-profit-25773498e0.md): The Bitmex Notional Leaderboard show the most profitable all-time traders on BitMEX in terms of notional value (only active and verified accounts are included). Unless a user has chosen to display their real name, an account pseudonym is used.
- Sentiment [Leaderboard ROE Profit](https://doc.dev.hyblockcapital.com/leaderboard-roe-profit-25773499e0.md): The Bitmex ROE Leaderboard show the most profitable all-time traders on BitMEX in terms of ROE or return on equity (only active and verified accounts are included). Unless a user has chosen to display their real name, an account pseudonym is used.
- Sentiment [WBTC Mint Burn](https://doc.dev.hyblockcapital.com/wbtc-mint-burn-25773500e0.md): Wrapped Bitcoin (WBTC) is an ERC20 token backed 1:1 with Bitcoin. Track when wBTC is minted (btc is exchanged to create wBTC) and burned (wBTC is swapped back for BTC) across a variety of members (approved entities).
- Liquidity [Liquidation](https://doc.dev.hyblockcapital.com/liquidation-25773501e0.md): Event where a trader’s leveraged position is forced to close, due to margin not being enough to cover the loss.
- Liquidity [Liquidation Levels Count](https://doc.dev.hyblockcapital.com/liquidation-levels-count-25773502e0.md): Tracks the number of predicted liquidation levels in two modes: