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

    Liquidity

    Liquidity API Endpoints Documentation#

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

    Table of Contents#

    Liquidation Events
    Liquidation Levels
    Leverage Metrics
    Liquidation Tools

    Liquidation Events#

    Liquidation#

    Endpoint: GET /v2/liquidation
    Description: Event where a trader's leveraged position is forced to close, due to margin not being enough to cover the loss.
    Summary: Liquidation

    Liquidation Levels#

    Liquidation Levels Count#

    Endpoint: GET /v2/liqLevelsCount
    Description: Tracks the number of predicted liquidation levels in two modes:
    Anchored: Aggregated at fixed time intervals (daily, 4-hourly, or hourly, UTC).
    Non-Anchored: Based on the most recent snapshot without anchoring.
    For each mode, it reports:
    Total counts of long and short liquidation levels
    Delta: Difference between long and short counts
    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.
    Summary: Liquidation Levels Count

    Liquidation Levels Size#

    Endpoint: GET /v2/liqLevelsSize
    Description: Measures the relative strength of predicted liquidation levels to compare zones of potential liquidation pressure. Available in two modes:
    Anchored: Aggregated at fixed intervals (daily, 4-hourly, or hourly, UTC).
    Non-Anchored: Based on the latest snapshot.
    For each mode, it highlights:
    Relative long vs. short strength
    Delta: Imbalance between long and short liquidation levels
    This helps spot where liquidation clusters may be more influential and whether positioning skews to one side.
    Summary: Liquidation Levels Size

    Anchored Liquidation Levels Count#

    Endpoint: GET /v2/anchoredLiqLevelsCount
    Description: 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.
    Summary: Anchored Liquidation Levels Count

    Anchored Liquidation Levels Size#

    Endpoint: GET /v2/anchoredLiqLevelsSize
    Description: 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.
    Summary: Anchored Liquidation Levels Size

    Liquidation Levels Trading View#

    Endpoint: GET /v2/liquidationLevelsTV
    Description: 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).
    Summary: Liquidation Levels Trading View

    Leverage Metrics#

    Average Leverage Used#

    Endpoint: GET /v2/averageLeverageUsed
    Description: 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.
    Summary: Top Trader Average Leverage Used

    Average Leverage Delta#

    Endpoint: GET /v2/averageLeverageDelta
    Description: 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.
    Summary: Top Trader Average Leverage Delta

    Top Trader Margin Used#

    Endpoint: GET /v2/topTraderMarginUsed
    Description: 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.
    Summary: Top Trader Margin Used

    Top Trader Margin Used Delta#

    Endpoint: GET /v2/topTraderMarginUsedDelta
    Description: 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.
    Summary: Top Trader Margin Used Delta

    Liquidation Tools#

    Liquidation Heatmap#

    Endpoint: GET /v2/liquidationHeatmap
    Description: 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.
    Summary: Liquidation Heatmap

    Liquidation Levels#

    Endpoint: GET /v2/liquidationLevels
    Description: Liquidation Levels are estimates of potential price levels where liquidation events may occur.
    Summary: Liquidation Levels

    Cumulative Liq Level#

    Endpoint: GET /v2/cumulativeLiqLevel
    Description: 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.
    Summary: Cumulative Liq 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)
    Note: Some endpoints may have additional parameters specific to their functionality, such as anchor periods for anchored endpoints, leverage filters, or position filters.

    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:14:15
    Previous
    WBTC Mint Burn
    Next
    Liquidation
    Built with