Hyblock API (Dev)
    Hyblock API (Dev)
    • Orderflow
      • Kline
        GET
      • Exchange Premium
        GET
      • Buy volume
        GET
      • Sell volume
        GET
      • Volume delta
        GET
      • Volume ratio
        GET
      • Anchored cvd
        GET
      • Bot Tracker
        GET
      • Slippage
        GET
      • Transfer Of Contracts
        GET
      • Participation Ratio
        GET
      • Market Order Count
        GET
      • Market Order Average Size
        GET
      • Limit Order Count
        GET
      • Limit Order Average Size
        GET
      • Buy Sell Trade Count Ratio
        GET
      • Limit Order Count Ratio
        GET
      • Market Order Count Ratio
        GET
      • Previous Day Level
        GET
      • Previous Week Level
        GET
      • Previous Month Level
        GET
    • Funding Rate
      • Funding Rate
        GET
    • Longs & Shorts
      • Top Trader Accounts
        GET
      • Top Trader Positions
        GET
      • Anchored Top Trader Accounts
        GET
      • Anchored Top Trader Positions
        GET
      • Global Accounts
        GET
      • Anchored Global Accounts
        GET
      • Net Long Short
        GET
      • Net Long Short Delta
        GET
      • Anchored CLSD
        GET
      • Anchored CLS
        GET
      • Whale Retail Delta
        GET
      • Anchored Whale Retail Delta
        GET
      • True Retail Long Short
        GET
      • Whale Position Dominance
        GET
      • Trader Sentiment Gap
        GET
    • Orderbook
      • Bid Ask
      • Bid Ask Ratio
      • Bid Ask Delta
      • Bid Ask Ratio Diff
      • Bids Ask Spread
      • Combined Book
      • Bids Increase Decrease
      • Asks Increase Decrease
      • Best Bid Ask
      • Market Imbalance Index
    • Global Metrics
      • Global Bid Ask
      • Global Bid Ask Ratio
      • Global Combined Book
      • Global Bid Ask Delta
      • Global Bid Ask Ratio Increase Decrease
      • Global Bids Increase Decrease
      • Global Asks Increase Decrease
    • Open Interest
      • Open Interest
      • Open Interest Delta
      • Anchored OI Delta
    • Options
      • Bvol
      • Dvol
    • Sentiment
      • Margin Lending Ratio
      • Fear And Greed
      • User Bot Ratio
      • Premium P2P
      • Leaderboard Notional Profit
      • Leaderboard ROE Profit
      • WBTC Mint Burn
    • Liquidity
      • Liquidation
      • Liquidation Levels Count
      • Liquidation Levels Size
      • Anchored Liquidation Levels Size
      • Anchored Liquidation Levels Count
      • Liquidation Levels Trading View
      • Top Trader Average Leverage Used
      • Top Trader Average Leverage Delta
      • Top Trader Margin Used
      • Top Trader Margin Used Delta
      • Liquidation Heatmap
      • Liquidation Levels
      • Cumulative Liq Level
    • Profile Tool
      • Profiles Tool Data
    • Position Heatmap
      • Positions Heatmap Data
    • Catalog
      • Catalog
    • System
      • Health Check
      • Availability
    • Schemas
      • AsksIncreaseDecreaseResponse
      • AnchoredCLSDResponse
      • BestBidAskResponse
      • AnchoredCLSResponse
      • BidAskDeltaResponse
      • AnchoredCVDResponse
      • BidAskRatioDiffResponse
      • AnchoredGlobalAccountsResponse
      • BidAskRatioResponse
      • AnchoredLiqLevelsCountResponse
      • BidAskResponse
      • AnchoredLiqLevelsSizeResponse
      • BidsAskSpreadResponse
      • AnchoredOIDeltaResponse
      • BidsIncreaseDecreaseResponse
      • AnchoredTopTraderAccountsResponse
      • BotTrackerResponse
      • AnchoredTopTraderPositionsResponse
      • BuySellTradeCountRatioResponse
      • AnchoredWhaleRetailDeltaResponse
      • BuyVolumeResponse
      • BvolResponse
      • CatalogResponse
      • CombinedBookResponse
      • CumulativeLiqLevelResponse
      • DataAvailabilityResponse
      • DvolResponse
      • ExchangePremiumResponse
      • FearAndGreedResponse
      • FundingRateResponse
      • GlobalAccountsResponse
      • GlobalAsksIncreaseDecreaseResponse
      • GlobalBidAskDeltaResponse
      • GlobalBidAskRatioIncreaseDecreaseResponse
      • GlobalBidAskRatioResponse
      • GlobalBidAskResponse
      • GlobalBidsIncreaseDecreaseResponse
      • GlobalCombinedBookResponse
      • KlinesResponse
      • LeaderboardNotionalProfitResponse
      • LeaderboardROEProfitResponse
      • LimitOrderAverageSizeResponse
      • LimitOrderCountRatioResponse
      • LimitOrderCountResponse
      • LiqLevelsCountResponse
      • LiqLevelsSizeResponse
      • LiquidationHeatmapResponse
      • LiquidationLevelResponse
      • LiquidationLevelsTVResponse
      • LiquidationResponse
      • MarginLendingRatioResponse
      • MarketImbalanceIndexResponse
      • MarketOrderAverageSizeResponse
      • MarketOrderCountRatioResponse
      • MarketOrderCountResponse
      • NetLongShortDeltaResponse
      • NetLongShortResponse
      • OpenInterestDeltaResponse
      • OpenInterestResponse
      • ParticipationRatioResponse
      • PositionHeatmapResponse
      • PremiumP2PResponse
      • PreviousDayLevelResponse
      • PreviousMonthLevelResponse
      • PreviousWeekLevelResponse
      • ProfileToolResponse
      • SellVolumeResponse
      • SlippageResponse
      • TopTraderAccountsResponse
      • TopTraderAverageLeverageDeltaResponse
      • TopTraderAverageLeverageUsedResponse
      • TopTraderMarginUsedDeltaResponse
      • TopTraderMarginUsedResponse
      • TopTraderPositionsResponse
      • TraderSentimentGapResponse
      • TransferOfContractsResponse
      • TrueRetailLongShortResponse
      • UserBotRatioResponse
      • VolumeDeltaResponse
      • VolumeRatioResponse
      • WBTCMintBurnResponse
      • WhalePositionDominanceResponse
      • WhaleRetailDeltaResponse
      • ErrorResponse

    Orderflow

    This document provides an overview of all Orderflow-tagged API endpoints available in the Hyblock Professional API v2.

    Table of Contents#

    Price & Volume Indicators
    Volume Analysis
    Order Type Analysis
    Market Metrics
    Previous Levels

    Price & Volume Indicators#

    Kline#

    Endpoint: GET /v2/klines
    Description: 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.
    Summary: Kline

    Volume Analysis#

    Buy Volume#

    Endpoint: GET /v2/buyVolume
    Description: Aggregates the volume from market buy orders, summing the size of every market order on the buy side to reflect buying pressure.
    Summary: Buy volume

    Sell Volume#

    Endpoint: GET /v2/sellVolume
    Description: Aggregates the volume from market sell orders, summing the size of every market order on the sell side to reflect selling pressure.
    Summary: Sell volume

    Volume Delta#

    Endpoint: GET /v2/volumeDelta
    Description: Calculates the difference between buy and sell volume, revealing which side (buy or sell) holds dominance in the market.
    Summary: Volume delta

    Volume Ratio#

    Endpoint: GET /v2/volumeRatio
    Description: 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.
    Summary: Volume ratio

    Anchored CVD#

    Endpoint: GET /v2/anchoredCVD
    Description: 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.
    Summary: Anchored cvd

    Order Type Analysis#

    Market Order Count#

    Endpoint: GET /v2/marketOrderCount
    Description: 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.
    Summary: Market Order Count

    Market Order Average Size#

    Endpoint: GET /v2/marketOrderAverageSize
    Description: 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.
    Summary: Market Order Average Size

    Limit Order Count#

    Endpoint: GET /v2/limitOrderCount
    Description: 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.
    Summary: Limit Order Count

    Limit Order Average Size#

    Endpoint: GET /v2/limitOrderAverageSize
    Description: 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.
    Summary: Limit Order Average Size

    Buy Sell Trade Count Ratio#

    Endpoint: GET /v2/buySellTradeCountRatio
    Description: 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.
    Summary: Buy Sell Trade Count Ratio

    Limit Order Count Ratio#

    Endpoint: GET /v2/limitOrderCountRatio
    Description: 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.
    Summary: Limit Order Count Ratio

    Market Order Count Ratio#

    Endpoint: GET /v2/marketOrderCountRatio
    Description: 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.
    Summary: Market Order Count Ratio

    Market Metrics#

    Bot Tracker#

    Endpoint: GET /v2/botTracker
    Description: 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.
    Summary: Bot Tracker

    Slippage#

    Endpoint: GET /v2/slippage
    Description: 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.
    Summary: Slippage

    Transfer Of Contracts#

    Endpoint: GET /v2/transferOfContracts
    Description: 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.
    Summary: Transfer Of Contracts

    Participation Ratio#

    Endpoint: GET /v2/participationRatio
    Description: 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.
    Summary: Participation Ratio

    Exchange Premium#

    Endpoint: GET /v2/exchangePremium
    Description: 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.
    Summary: Exchange Premium

    Previous Levels#

    Previous Day Level#

    Endpoint: GET /v2/pdLevels
    Description: 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).
    Summary: Previous Day Level

    Previous Week Level#

    Endpoint: GET /v2/pwLevels
    Description: 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).
    Summary: Previous Week Level

    Previous Month Level#

    Endpoint: GET /v2/pmLevels
    Description: 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).
    Summary: Previous Month Level

    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: 600 requests per minute
    Burst Limit: 10 concurrent requests

    Base URL#

    All endpoints are prefixed with /v2/ and should be accessed via the base API URL.
    Modified at 2025-12-30 13:06:14
    Next
    Kline
    Built with