# Hyblock API (Dev) ## Docs - [Orderflow](https://docs.dev.hyblockcapital.com/orderflow.md): - [Funding Rate](https://docs.dev.hyblockcapital.com/funding-rate-5970314f0.md): - [Longs & Shorts](https://docs.dev.hyblockcapital.com/longs-shorts-5970315f0.md): - [Orderbook](https://docs.dev.hyblockcapital.com/orderbook-5970316f0.md): - [Global Metrics](https://docs.dev.hyblockcapital.com/global-metrics-5970317f0.md): - [Open Interest](https://docs.dev.hyblockcapital.com/open-interest-5970318f0.md): - [Options](https://docs.dev.hyblockcapital.com/options-5970319f0.md): - [Sentiment](https://docs.dev.hyblockcapital.com/sentiment-5970320f0.md): - [Liquidity](https://docs.dev.hyblockcapital.com/liquidity-5970321f0.md): - [Profile Tool](https://docs.dev.hyblockcapital.com/profile-tool-5970322f0.md): - [Position Heatmap](https://docs.dev.hyblockcapital.com/position-heatmap-5970323f0.md): - [Catalog](https://docs.dev.hyblockcapital.com/catalog-5970324f0.md): - [System](https://docs.dev.hyblockcapital.com/system-5970325f0.md): ## API Docs - Orderflow [Kline](https://docs.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://docs.dev.hyblockcapital.com/exchange-premium-25773444e0.md): Measures the price difference of an asset between two exchanges using closing prices, expressed as either a raw price difference or percentage premium. A positive value indicates the asset is trading higher on the reference exchange. - Orderflow [Buy volume](https://docs.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://docs.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://docs.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://docs.dev.hyblockcapital.com/volume-ratio-25773448e0.md): An oscillator ranging from -1 to 1 that measures the imbalance between market buy volume and market sell volume, calculated as (buy − sell) / (buy + sell). It focuses on order size (volume) rather than order count (tape). Positive values indicate aggressive buy volume dominance, negative values indicate aggressive sell volume dominance, and values near zero suggest balanced two-way execution. - Orderflow [Anchored cvd](https://docs.dev.hyblockcapital.com/anchored-cvd-26043329e0.md): Calculates the Cumulative Volume Delta (CVD), anchored daily, 4-hourly, or hourly (UTC timezone), enabling users to easily track volume shifts relative to previous periods for trend analysis. - Orderflow [Bot Tracker](https://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.dev.hyblockcapital.com/buy-sell-trade-count-ratio-25773457e0.md): An oscillator ranging from -1 to 1 that captures net buy or sell pressure by aggregating imbalances from both market and limit order executions, reflecting the combined directional outcome of aggressive and passive trading. - Orderflow [Limit Order Count Ratio](https://docs.dev.hyblockcapital.com/limit-order-count-ratio-25773458e0.md): An oscillator ranging from −1 to 1 calculated as (executed limit buy count − executed limit sell count) / (executed limit buy count + executed limit sell count). It measures the imbalance in executed passive liquidity, indicating whether market orders are predominantly hitting limit buys or limit sells. This metric reflects executed limit orders (passive fills), not resting orderbook depth or displayed liquidity. - Orderflow [Market Order Count Ratio](https://docs.dev.hyblockcapital.com/market-order-count-ratio-25773459e0.md): An oscillator ranging from -1 to 1 calculated as (market buy count − market sell count) / (market buy count + market sell count). It reflects the directional imbalance of aggressive trade execution. - Orderflow [Previous Day Level](https://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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 [Anchored Top Trader Accounts](https://docs.dev.hyblockcapital.com/anchored-top-trader-accounts-26043330e0.md): Measures top trader accounts, anchored daily, 4-hourly, or hourly (UTC timezone), capturing the total number of top trader accounts on Binance holding long or short positions. Top trader accounts are defined as those within the top 20% in terms of margin or balance, as classified by Binance, and do not necessarily represent the best traders or those with the highest profits. Each top trader account is counted as a single 'vote' to determine the percentage of accounts that are net long or net short. For example, if there are 100,000 top trader accounts and 60,000 are net long, the top trader accounts long percentage is 60%, and the short percentage is 40%. This endpoint provides insights into the market sentiment and directional bias among Binance's top trader accounts. - Longs & Shorts [Anchored Top Trader Positions](https://docs.dev.hyblockcapital.com/anchored-top-trader-positions-26043331e0.md): Measures top trader positions, anchored daily, 4-hourly, or hourly (UTC timezone), capturing the total number of top trader positions on Binance that are long or short. Top trader positions are defined as those within the top 20% in terms of margin or balance, as classified by Binance. Unlike account-based metrics, this endpoint focuses on individual positions (size). For example, if top trader positions hold $100,000 positions and $60,000 are long, the top trader positions long percentage is 60%, and the short percentage is 40%. This endpoint provides insights into the market sentiment and directional bias reflected in the positions of Binance's top traders. - Longs & Shorts [Global Accounts](https://docs.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 [Anchored Global Accounts](https://docs.dev.hyblockcapital.com/anchored-global-accounts-26043332e0.md): Measures global accounts, anchored daily, 4-hourly, or hourly (UTC timezone), capturing the total number of Binance accounts holding long or short positions. Each account is counted as a single 'vote' to determine the percentage of accounts that are net long or net short. For example, if Binance has 1,000,000 active accounts and 600,000 are net long, the global accounts long percentage is 60%, and the short percentage is 40%. This endpoint provides insights into market sentiment and directional bias among Binance users. - Longs & Shorts [Net Long Short](https://docs.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://docs.dev.hyblockcapital.com/net-long-short-delta-25773468e0.md): The difference between Net Longs and Net Shorts. - Longs & Shorts [Anchored CLSD](https://docs.dev.hyblockcapital.com/anchored-clsd-26043333e0.md): Tracks the cumulative sum of net longs and shorts delta (CLSD) with a daily, 4-hourly, or hourly anchor (UTC timezone), allowing clearer insights into net long versus short positioning trends over time. - Longs & Shorts [Anchored CLS](https://docs.dev.hyblockcapital.com/anchored-cls-26043334e0.md): Tracks the cumulative sum of net longs and shorts (CLS) with a daily, 4-hourly, or hourly anchor (UTC timezone), allowing clearer insights into net long versus short positioning trends over time. - Longs & Shorts [Whale Retail Delta](https://docs.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 [Anchored Whale Retail Delta](https://docs.dev.hyblockcapital.com/anchored-whale-retail-delta-26043335e0.md): Measures whale vs retail delta anchored daily, 4-hourly, or hourly (UTC timezone), calculating the difference between the long percentage of top trader positions ('whales') and the long percentage of global accounts ('retail') on Binance. Top trader positions are those within the top 20% in terms of margin or balance, as classified by Binance. For example, if top trader positions have a long percentage of 65% and global accounts have a long percentage of 55%, the whale-retail delta is +10. This endpoint provides insights into the divergence in market sentiment between Binance's top traders positions and the broader retail account base. - Longs & Shorts [True Retail Long Short](https://docs.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://docs.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://docs.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://docs.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://docs.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://docs.dev.hyblockcapital.com/bid-ask-delta-25773475e0.md): Evaluate the immediate disparity between buy and sell orders. - Orderbook [Bid Ask Ratio Diff](https://docs.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://docs.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://docs.dev.hyblockcapital.com/combined-book-25773478e0.md): A consolidated perspective of the market's orderbook dynamics. - Orderbook [Bids Increase Decrease](https://docs.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://docs.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://docs.dev.hyblockcapital.com/best-bid-ask-25773481e0.md): 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. - Orderbook [Market Imbalance Index](https://docs.dev.hyblockcapital.com/market-imbalance-index-25773482e0.md): 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. - Global Metrics [Global Bid Ask](https://docs.dev.hyblockcapital.com/global-bid-ask-25773483e0.md): Returns the aggregated bid and ask volume across all tickers (1000+ assets) on supported exchanges, effectively creating a global orderbook that represents market-wide liquidity. - Global Metrics [Global Bid Ask Ratio](https://docs.dev.hyblockcapital.com/global-bid-ask-ratio-25773484e0.md): Returns the ratio of aggregated global bid volume to aggregated global ask volume across all tickers (1000+ assets) on supported exchanges. The ratio is normalized to oscillate between -1 and 1, where 0 indicates balanced supply and demand. - Global Metrics [Global Combined Book](https://docs.dev.hyblockcapital.com/global-combined-book-25773485e0.md): Returns the combined global orderbook liquidity by summing aggregated bids and aggregated asks across all tickers (1000+ assets) on supported exchanges. - Global Metrics [Global Bid Ask Delta](https://docs.dev.hyblockcapital.com/global-bid-ask-delta-25773486e0.md): Returns the net global liquidity imbalance by subtracting aggregated global asks from aggregated global bids across all tickers (1000+ assets). Positive values indicate buy-side pressure; negative values indicate sell-side pressure. - Global Metrics [Global Bid Ask Ratio Increase Decrease](https://docs.dev.hyblockcapital.com/global-bid-ask-ratio-increase-decrease-25773487e0.md): Returns the change in the Global Bid Ask Ratio across all tickers (1000+ assets) compared to the previous candle. Calculated as Ratio(t) − Ratio(t-1), showing whether global buy/sell pressure is strengthening or weakening. - Global Metrics [Global Bids Increase Decrease](https://docs.dev.hyblockcapital.com/global-bids-increase-decrease-25773488e0.md): Returns the change in aggregated global bid volume across all tickers (1000+ assets) compared to the previous candle. Calculated as Bids(t) − Bids(t-1), indicating whether global buy-side liquidity is rising or falling. - Global Metrics [Global Asks Increase Decrease](https://docs.dev.hyblockcapital.com/global-asks-increase-decrease-25773489e0.md): Returns the change in aggregated global ask volume across all tickers (1000+ assets) compared to the previous candle. Calculated as Asks(t) − Asks(t-1), indicating whether global sell-side liquidity is rising or falling. - Open Interest [Open Interest](https://docs.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://docs.dev.hyblockcapital.com/open-interest-delta-25773491e0.md): Change in open interest over a specific time period. - Open Interest [Anchored OI Delta](https://docs.dev.hyblockcapital.com/anchored-oi-delta-26043336e0.md): Measures Open Interest Delta (OIDelta) anchored daily, 4-hourly, or hourly (UTC timezone), offering comparative insights into open interest changes against prior periods. - Options [Bvol](https://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.dev.hyblockcapital.com/liquidation-levels-count-25773502e0.md): Tracks the number of predicted liquidation levels in two modes:

For each mode, it reports:
This indicator helps pinpoint areas of liquidation pressure and reveals whether positioning skews toward longs or shorts. Users can choose between anchored or non-anchored views to fit their analysis. - Liquidity [Liquidation Levels Size](https://docs.dev.hyblockcapital.com/liquidation-levels-size-25773503e0.md): Measures the relative strength of predicted liquidation levels to compare zones of potential liquidation pressure. Available in two modes:

For each mode, it highlights:
This helps spot where liquidation clusters may be more influential and whether positioning skews to one side. - Liquidity [Anchored Liquidation Levels Size](https://docs.dev.hyblockcapital.com/anchored-liquidation-levels-size-26043337e0.md): Measures the aggregated size of predicted liquidation levels, anchored daily, 4-hourly, or hourly (UTC timezone). It calculates the total notional size of long and short liquidation levels at each anchor point, along with the delta (difference between long and short sizes). This highlights not only the magnitude of potential liquidation events but also the directional imbalance between long and short positioning. - Liquidity [Anchored Liquidation Levels Count](https://docs.dev.hyblockcapital.com/anchored-liquidation-levels-count-26043338e0.md): Measures the number of predicted liquidation levels, anchored daily, 4-hourly, or hourly (UTC timezone). It captures the total count of long and short liquidation levels at each anchor point, along with the delta (difference between long and short counts). This provides insights into where liquidation pressure is concentrated and whether it skews toward longs or shorts. - Liquidity [Liquidation Levels Trading View](https://docs.dev.hyblockcapital.com/liquidation-levels-trading-view-25773504e0.md): This endpoint provides access to open liquidation levels for specified coins and exchanges on TradingView charts, retrieving detailed information based on filters like leverage, position, tier, open duration, and open interest delta to volume ratio (oidv). - Liquidity [Top Trader Average Leverage Used](https://docs.dev.hyblockcapital.com/top-trader-average-leverage-used-25773505e0.md): This metric shows the average leverage used in long and short positions by top traders, identified as those within the top percentage holding the largest open position values. - Liquidity [Top Trader Average Leverage Delta](https://docs.dev.hyblockcapital.com/top-trader-average-leverage-delta-25773506e0.md): This metric captures the difference between the average leverage used in long and short positions by top traders, highlighting which side is utilizing more leverage. - Liquidity [Top Trader Margin Used](https://docs.dev.hyblockcapital.com/top-trader-margin-used-25773507e0.md): Shows the total margin used by top traders, separated into margin used by long positions and short positions. This helps identify where leveraged positioning is concentrated among top participants. - Liquidity [Top Trader Margin Used Delta](https://docs.dev.hyblockcapital.com/top-trader-margin-used-delta-25773508e0.md): The net difference between margin used by top trader long positions and top trader short positions. Positive values indicate more long margin is used while negative values indicate more short margin is used. - Liquidity [Liquidation Heatmap](https://docs.dev.hyblockcapital.com/liquidation-heatmap-25773509e0.md): The Liquidation Heatmap API endpoint, provided by Hyblock, predicts price buckets where liquidations may occur, enabling traders to visualize and anticipate potential liquidation levels. It delivers data on open predictive liquidations with the most recent timestamp, helping traders identify high-liquidity zones where significant liquidation events are likely. - Liquidity [Liquidation Levels](https://docs.dev.hyblockcapital.com/liquidation-levels-25773510e0.md): Liquidation Levels are estimates of potential price levels where liquidation events may occur. - Liquidity [Cumulative Liq Level](https://docs.dev.hyblockcapital.com/cumulative-liq-level-25773511e0.md): Shows the general statistics of predicted liquidation levels, including the number of open long and short liquidation levels by size and count and the differences between them. - Profile Tool [Profiles Tool Data](https://docs.dev.hyblockcapital.com/profiles-tool-data-25773512e0.md): Profiles Tools take the concept of volume profile analysis to the next level by incorporating additional data such as volume delta, open interest, and liquidations. This type of graph helps you understand the distribution of trading activity over different price levels, providing insights into where significant buying and selling pressures exist. - Position Heatmap [Positions Heatmap Data](https://docs.dev.hyblockcapital.com/positions-heatmap-data-25773513e0.md): The Positions Heatmap API endpoint tracks open interest, net longs, net shorts, and net long-short delta across price buckets, visualizing where traders are opening or closing positions. It provides insights into market sentiment, support/resistance zones, and potential trapped traders, with data reflecting the most recent timestamp only for up-to-date market positioning. - Catalog [Catalog](https://docs.dev.hyblockcapital.com/catalog-25773514e0.md): List of supported symbols, endpoinNames, and exchanges. - System [Health Check](https://docs.dev.hyblockcapital.com/health-check-25773515e0.md): - System [Availability](https://docs.dev.hyblockcapital.com/availability-25773516e0.md): This is to help users programmatically check the availability range for any supported data stream. This allows to determine the earliest available date for historical data tied to a specific endpoint. ## Schemas - [AsksIncreaseDecreaseResponse](https://docs.dev.hyblockcapital.com/asksincreasedecreaseresponse-11729002d0.md): - [AnchoredCLSDResponse](https://docs.dev.hyblockcapital.com/anchoredclsdresponse-11869649d0.md): - [BestBidAskResponse](https://docs.dev.hyblockcapital.com/bestbidaskresponse-11729003d0.md): - [AnchoredCLSResponse](https://docs.dev.hyblockcapital.com/anchoredclsresponse-11869650d0.md): - [BidAskDeltaResponse](https://docs.dev.hyblockcapital.com/bidaskdeltaresponse-11729004d0.md): - [AnchoredCVDResponse](https://docs.dev.hyblockcapital.com/anchoredcvdresponse-11869651d0.md): - [BidAskRatioDiffResponse](https://docs.dev.hyblockcapital.com/bidaskratiodiffresponse-11729005d0.md): - [AnchoredGlobalAccountsResponse](https://docs.dev.hyblockcapital.com/anchoredglobalaccountsresponse-11869652d0.md): - [BidAskRatioResponse](https://docs.dev.hyblockcapital.com/bidaskratioresponse-11729006d0.md): - [AnchoredLiqLevelsCountResponse](https://docs.dev.hyblockcapital.com/anchoredliqlevelscountresponse-11869653d0.md): - [BidAskResponse](https://docs.dev.hyblockcapital.com/bidaskresponse-11729007d0.md): - [AnchoredLiqLevelsSizeResponse](https://docs.dev.hyblockcapital.com/anchoredliqlevelssizeresponse-11869654d0.md): - [BidsAskSpreadResponse](https://docs.dev.hyblockcapital.com/bidsaskspreadresponse-11729008d0.md): - [AnchoredOIDeltaResponse](https://docs.dev.hyblockcapital.com/anchoredoideltaresponse-11869655d0.md): - [BidsIncreaseDecreaseResponse](https://docs.dev.hyblockcapital.com/bidsincreasedecreaseresponse-11729009d0.md): - [AnchoredTopTraderAccountsResponse](https://docs.dev.hyblockcapital.com/anchoredtoptraderaccountsresponse-11869656d0.md): - [BotTrackerResponse](https://docs.dev.hyblockcapital.com/bottrackerresponse-11729010d0.md): - [AnchoredTopTraderPositionsResponse](https://docs.dev.hyblockcapital.com/anchoredtoptraderpositionsresponse-11869657d0.md): - [BuySellTradeCountRatioResponse](https://docs.dev.hyblockcapital.com/buyselltradecountratioresponse-11729011d0.md): - [AnchoredWhaleRetailDeltaResponse](https://docs.dev.hyblockcapital.com/anchoredwhaleretaildeltaresponse-11869658d0.md): - [BuyVolumeResponse](https://docs.dev.hyblockcapital.com/buyvolumeresponse-11729012d0.md): - [BvolResponse](https://docs.dev.hyblockcapital.com/bvolresponse-11729013d0.md): - [CatalogResponse](https://docs.dev.hyblockcapital.com/catalogresponse-11729014d0.md): - [CombinedBookResponse](https://docs.dev.hyblockcapital.com/combinedbookresponse-11729015d0.md): - [CumulativeLiqLevelResponse](https://docs.dev.hyblockcapital.com/cumulativeliqlevelresponse-11729016d0.md): - [DataAvailabilityResponse](https://docs.dev.hyblockcapital.com/dataavailabilityresponse-11729017d0.md): - [DvolResponse](https://docs.dev.hyblockcapital.com/dvolresponse-11729018d0.md): - [ExchangePremiumResponse](https://docs.dev.hyblockcapital.com/exchangepremiumresponse-11729019d0.md): - [FearAndGreedResponse](https://docs.dev.hyblockcapital.com/fearandgreedresponse-11729020d0.md): - [FundingRateResponse](https://docs.dev.hyblockcapital.com/fundingrateresponse-11729021d0.md): - [GlobalAccountsResponse](https://docs.dev.hyblockcapital.com/globalaccountsresponse-11729022d0.md): - [GlobalAsksIncreaseDecreaseResponse](https://docs.dev.hyblockcapital.com/globalasksincreasedecreaseresponse-11729023d0.md): - [GlobalBidAskDeltaResponse](https://docs.dev.hyblockcapital.com/globalbidaskdeltaresponse-11729024d0.md): - [GlobalBidAskRatioIncreaseDecreaseResponse](https://docs.dev.hyblockcapital.com/globalbidaskratioincreasedecreaseresponse-11729025d0.md): - [GlobalBidAskRatioResponse](https://docs.dev.hyblockcapital.com/globalbidaskratioresponse-11729026d0.md): - [GlobalBidAskResponse](https://docs.dev.hyblockcapital.com/globalbidaskresponse-11729027d0.md): - [GlobalBidsIncreaseDecreaseResponse](https://docs.dev.hyblockcapital.com/globalbidsincreasedecreaseresponse-11729028d0.md): - [GlobalCombinedBookResponse](https://docs.dev.hyblockcapital.com/globalcombinedbookresponse-11729029d0.md): - [KlinesResponse](https://docs.dev.hyblockcapital.com/klinesresponse-11729030d0.md): - [LeaderboardNotionalProfitResponse](https://docs.dev.hyblockcapital.com/leaderboardnotionalprofitresponse-11729031d0.md): - [LeaderboardROEProfitResponse](https://docs.dev.hyblockcapital.com/leaderboardroeprofitresponse-11729032d0.md): - [LimitOrderAverageSizeResponse](https://docs.dev.hyblockcapital.com/limitorderaveragesizeresponse-11729033d0.md): - [LimitOrderCountRatioResponse](https://docs.dev.hyblockcapital.com/limitordercountratioresponse-11729034d0.md): - [LimitOrderCountResponse](https://docs.dev.hyblockcapital.com/limitordercountresponse-11729035d0.md): - [LiqLevelsCountResponse](https://docs.dev.hyblockcapital.com/liqlevelscountresponse-11729036d0.md): - [LiqLevelsSizeResponse](https://docs.dev.hyblockcapital.com/liqlevelssizeresponse-11729037d0.md): - [LiquidationHeatmapResponse](https://docs.dev.hyblockcapital.com/liquidationheatmapresponse-11729038d0.md): - [LiquidationLevelResponse](https://docs.dev.hyblockcapital.com/liquidationlevelresponse-11729039d0.md): - [LiquidationLevelsTVResponse](https://docs.dev.hyblockcapital.com/liquidationlevelstvresponse-11729040d0.md): - [LiquidationResponse](https://docs.dev.hyblockcapital.com/liquidationresponse-11729041d0.md): - [MarginLendingRatioResponse](https://docs.dev.hyblockcapital.com/marginlendingratioresponse-11729042d0.md): - [MarketImbalanceIndexResponse](https://docs.dev.hyblockcapital.com/marketimbalanceindexresponse-11729043d0.md): - [MarketOrderAverageSizeResponse](https://docs.dev.hyblockcapital.com/marketorderaveragesizeresponse-11729044d0.md): - [MarketOrderCountRatioResponse](https://docs.dev.hyblockcapital.com/marketordercountratioresponse-11729045d0.md): - [MarketOrderCountResponse](https://docs.dev.hyblockcapital.com/marketordercountresponse-11729046d0.md): - [NetLongShortDeltaResponse](https://docs.dev.hyblockcapital.com/netlongshortdeltaresponse-11729047d0.md): - [NetLongShortResponse](https://docs.dev.hyblockcapital.com/netlongshortresponse-11729048d0.md): - [OpenInterestDeltaResponse](https://docs.dev.hyblockcapital.com/openinterestdeltaresponse-11729049d0.md): - [OpenInterestResponse](https://docs.dev.hyblockcapital.com/openinterestresponse-11729050d0.md): - [ParticipationRatioResponse](https://docs.dev.hyblockcapital.com/participationratioresponse-11729051d0.md): - [PositionHeatmapResponse](https://docs.dev.hyblockcapital.com/positionheatmapresponse-11729052d0.md): - [PremiumP2PResponse](https://docs.dev.hyblockcapital.com/premiump2presponse-11729053d0.md): - [PreviousDayLevelResponse](https://docs.dev.hyblockcapital.com/previousdaylevelresponse-11729054d0.md): - [PreviousMonthLevelResponse](https://docs.dev.hyblockcapital.com/previousmonthlevelresponse-11729055d0.md): - [PreviousWeekLevelResponse](https://docs.dev.hyblockcapital.com/previousweeklevelresponse-11729056d0.md): - [ProfileToolResponse](https://docs.dev.hyblockcapital.com/profiletoolresponse-11729057d0.md): - [SellVolumeResponse](https://docs.dev.hyblockcapital.com/sellvolumeresponse-11729058d0.md): - [SlippageResponse](https://docs.dev.hyblockcapital.com/slippageresponse-11729059d0.md): - [TopTraderAccountsResponse](https://docs.dev.hyblockcapital.com/toptraderaccountsresponse-11729060d0.md): - [TopTraderAverageLeverageDeltaResponse](https://docs.dev.hyblockcapital.com/toptraderaverageleveragedeltaresponse-11729061d0.md): - [TopTraderAverageLeverageUsedResponse](https://docs.dev.hyblockcapital.com/toptraderaverageleverageusedresponse-11729062d0.md): - [TopTraderMarginUsedDeltaResponse](https://docs.dev.hyblockcapital.com/toptradermarginuseddeltaresponse-11729063d0.md): - [TopTraderMarginUsedResponse](https://docs.dev.hyblockcapital.com/toptradermarginusedresponse-11729064d0.md): - [TopTraderPositionsResponse](https://docs.dev.hyblockcapital.com/toptraderpositionsresponse-11729065d0.md): - [TraderSentimentGapResponse](https://docs.dev.hyblockcapital.com/tradersentimentgapresponse-11729066d0.md): - [TransferOfContractsResponse](https://docs.dev.hyblockcapital.com/transferofcontractsresponse-11729067d0.md): - [TrueRetailLongShortResponse](https://docs.dev.hyblockcapital.com/trueretaillongshortresponse-11729068d0.md): - [UserBotRatioResponse](https://docs.dev.hyblockcapital.com/userbotratioresponse-11729069d0.md): - [VolumeDeltaResponse](https://docs.dev.hyblockcapital.com/volumedeltaresponse-11729070d0.md): - [VolumeRatioResponse](https://docs.dev.hyblockcapital.com/volumeratioresponse-11729071d0.md): - [WBTCMintBurnResponse](https://docs.dev.hyblockcapital.com/wbtcmintburnresponse-11729072d0.md): - [WhalePositionDominanceResponse](https://docs.dev.hyblockcapital.com/whalepositiondominanceresponse-11729073d0.md): - [WhaleRetailDeltaResponse](https://docs.dev.hyblockcapital.com/whaleretaildeltaresponse-11729074d0.md): - [ErrorResponse](https://docs.dev.hyblockcapital.com/errorresponse-11924644d0.md):