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

    Sentiment

    Sentiment API Endpoints Documentation#

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

    Table of Contents#

    Market Sentiment Indicators
    User Metrics
    Premium Indicators
    Leaderboard
    On-Chain Metrics

    Market Sentiment Indicators#

    Fear And Greed#

    Endpoint: GET /v2/fearAndGreed
    Description: 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.
    Summary: Fear And Greed

    Margin Lending Ratio#

    Endpoint: GET /v2/marginLendingRatio
    Description: 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.
    Summary: Margin Lending Ratio

    User Metrics#

    User Bot Ratio#

    Endpoint: GET /v2/userBotRatio
    Description: This indicator shows the number of users and bots (via api) connected to Bitmex and the ratio between them.
    Summary: User Bot Ratio

    Premium Indicators#

    Premium P2P#

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

    Leaderboard#

    Leaderboard Notional Profit#

    Endpoint: GET /v2/leaderboardNotionalProfit
    Description: 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.
    Summary: Leaderboard Notional Profit

    Leaderboard ROE Profit#

    Endpoint: GET /v2/leaderboardROEProfit
    Description: 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.
    Summary: Leaderboard ROE Profit

    On-Chain Metrics#

    WBTC Mint Burn#

    Endpoint: GET /v2/wbtcMintBurn
    Description: 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).
    Summary: WBTC Mint Burn

    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.

    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.
    For detailed request/response schemas and examples, please refer to the OpenAPI specification at /v2/openapi.json or visit the interactive API documentation.
    Modified at 2025-12-30 13:15:40
    Previous
    Dvol
    Next
    Margin Lending Ratio
    Built with