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

    Longs & Shorts API Endpoints

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

    Table of Contents#

    Top Trader Metrics
    Global Account Metrics
    Net Long Short Metrics
    Whale & Retail Analysis
    Sentiment Analysis

    Top Trader Metrics#

    Top Trader Accounts#

    Endpoint: GET /v2/topTraderAccounts
    Description: 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.
    Summary: Top Trader Accounts

    Top Trader Positions#

    Endpoint: GET /v2/topTraderPositions
    Description: 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.
    Summary: Top Trader Positions

    Anchored Top Trader Accounts#

    Endpoint: GET /v2/anchoredTopTraderAccounts
    Description: 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.
    Summary: Anchored Top Trader Accounts

    Anchored Top Trader Positions#

    Endpoint: GET /v2/anchoredTopTraderPositions
    Description: 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,000positionsand60,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.
    Summary: Anchored Top Trader Positions

    Global Account Metrics#

    Global Accounts#

    Endpoint: GET /v2/globalAccounts
    Description: 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'.
    Summary: Global Accounts

    Anchored Global Accounts#

    Endpoint: GET /v2/anchoredGlobalAccounts
    Description: 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.
    Summary: Anchored Global Accounts

    Net Long Short Metrics#

    Net Long Short#

    Endpoint: GET /v2/netLongShort
    Description: Estimated net longs and net shorts derived from taker orders & open interest.
    Summary: Net Long Short

    Net Long Short Delta#

    Endpoint: GET /v2/netLongShortDelta
    Description: The difference between Net Longs and Net Shorts.
    Summary: Net Long Short Delta

    Anchored CLSD#

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

    Anchored CLS#

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

    Whale & Retail Analysis#

    Whale Retail Delta#

    Endpoint: GET /v2/whaleRetailDelta
    Description: This is the difference between top trader positions long% ('whales') and global accounts long% ('retail').
    Summary: Whale Retail Delta

    Anchored Whale Retail Delta#

    Endpoint: GET /v2/anchoredWhaleRetailDelta
    Description: 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.
    Summary: Anchored Whale Retail Delta

    Whale Position Dominance#

    Endpoint: GET /v2/whalePositionDominance
    Description: 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.
    Summary: Whale Position Dominance

    True Retail Long Short#

    Endpoint: GET /v2/trueRetailLongShort
    Description: This metric shows the percentage of retail accounts in long versus short positions, with each account equally contributing one vote, regardless of position size.
    Summary: True Retail Long Short

    Sentiment Analysis#

    Trader Sentiment Gap#

    Endpoint: GET /v2/traderSentimentGap
    Description: 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.
    Summary: Trader Sentiment Gap

    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)
    Note: Some endpoints may have additional parameters specific to their functionality, such as anchor periods for anchored endpoints.

    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:10:15
    Previous
    Funding Rate
    Next
    Top Trader Accounts
    Built with