Hyblock API
    Hyblock API
    • Orderflow
      • Kline
        GET
      • Buy volume
        GET
      • Sell volume
        GET
      • Volume delta
        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
      • 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
    • 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
      • Anchored Liquidation Levels Count
      • Anchored Liquidation Levels Size
      • Liquidation Levels Trading View
      • Top Trader Average Leverage Used
      • Top Trader Average Leverage 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
      • AnchoredCLSDResponse
      • AnchoredCLSResponse
      • AnchoredCVDResponse
      • AnchoredGlobalAccountsResponse
      • AnchoredLiqLevelsCountResponse
      • AnchoredLiqLevelsSizeResponse
      • AnchoredOIDeltaResponse
      • AnchoredTopTraderAccountsResponse
      • AnchoredTopTraderPositionsResponse
      • AnchoredWhaleRetailDeltaResponse
      • AsksIncreaseDecreaseResponse
      • BidAskDeltaResponse
      • BidAskRatioDiffResponse
      • BidAskRatioResponse
      • BidAskResponse
      • BidsAskSpreadResponse
      • BidsIncreaseDecreaseResponse
      • BotTrackerResponse
      • BuyVolumeResponse
      • BvolResponse
      • CatalogResponse
      • CombinedBookResponse
      • CumulativeLiqLevelResponse
      • DataAvailabilityResponse
      • DvolResponse
      • FearAndGreedResponse
      • FundingRateResponse
      • GlobalAccountsResponse
      • GlobalAsksIncreaseDecreaseResponse
      • GlobalBidAskDeltaResponse
      • GlobalBidAskRatioIncreaseDecreaseResponse
      • GlobalBidAskRatioResponse
      • GlobalBidAskResponse
      • GlobalBidsIncreaseDecreaseResponse
      • GlobalCombinedBookResponse
      • KlinesResponse
      • LeaderboardNotionalProfitResponse
      • LeaderboardROEProfitResponse
      • LimitOrderAverageSizeResponse
      • LimitOrderCountResponse
      • LiquidationHeatmapResponse
      • LiquidationLevelResponse
      • LiquidationLevelsTVResponse
      • LiquidationResponse
      • MarginLendingRatioResponse
      • MarketOrderAverageSizeResponse
      • MarketOrderCountResponse
      • NetLongShortDeltaResponse
      • NetLongShortResponse
      • OpenInterestDeltaResponse
      • OpenInterestResponse
      • ParticipationRatioResponse
      • PositionHeatmapResponse
      • PremiumP2PResponse
      • PreviousDayLevelResponse
      • PreviousMonthLevelResponse
      • PreviousWeekLevelResponse
      • ProfileToolResponse
      • SellVolumeResponse
      • SlippageResponse
      • TopTraderAccountsResponse
      • TopTraderAverageLeverageDeltaResponse
      • TopTraderAverageLeverageUsedResponse
      • TopTraderPositionsResponse
      • TraderSentimentGapResponse
      • TransferOfContractsResponse
      • TrueRetailLongShortResponse
      • UserBotRatioResponse
      • VolumeDeltaResponse
      • WBTCMintBurnResponse
      • WhalePositionDominanceResponse
      • WhaleRetailDeltaResponse
      • ErrorResponse

    System

    Table of Contents#

    Health Check
    Data Availability

    Health Check#

    Ping#

    Endpoint: GET /v2/ping
    Description: Health check endpoint to verify API availability.
    Summary: Health Check

    Data Availability#

    Availability#

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

    Common Parameters#

    The data availability endpoint accepts the following query parameters:
    endpointName: Name of the endpoint to check availability for
    exchange: Exchange identifier (optional)
    symbol: Symbol identifier (optional)

    Authentication#

    All endpoints require authentication via:
    API Key: x-api-key header
    OAuth2: Bearer token
    Note: The ping endpoint may be accessible without authentication depending on your configuration.

    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 2026-01-19 10:56:14
    Previous
    Catalog
    Next
    Health Check
    Built with