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

    Connect the Hyblock MCP

    The Hyblock MCP is a remote Model Context Protocol server. It lets an AI assistant like Claude or Cursor use Hyblock directly. Once it is connected, you can ask in plain English ("Where are the big BTC liquidation levels right now?", "Backtest longing ETH after negative funding with rising OI") and the assistant calls Hyblock's tools on your behalf, using your own Hyblock account and plan.

    MCP server URL#

    https://hyblockcapital.com/api/mcp
    Transport: Streamable HTTP (remote). You don't install anything locally.
    Sign-in: OAuth. You sign in with your normal Hyblock account and choose Allow. You don't need an API key, and you never paste one into a prompt.

    What your AI can do#

    These are the tools the server exposes today:
    AreaToolsWhat they do
    Account & catalogget_account, list_indicators, list_symbols, list_exchangesShows your plan and which features it includes, plus the indicator, coin and exchange catalog
    Liquidity & positioningliquidation_heatmap, liquidation_levels, net_position_heatmap, profile_by_symbolShows estimated liquidation levels and open liquidation levels around the price, the Net Positions Heatmap, and indicators by price (profiles)
    Screenersscreener_by_indicator, screener_by_symbol, rankmap_by_indicator, rankmap_by_symbol, histogram_by_indicator, histogram_by_symbol, correlation_by_indicator, correlation_by_symbol, coin_quadrantRuns the Coin Screener, Rank Map, Probability Histogram, Correlation Scanner and Coin Quadrant across Hyblock indicators. These include orderbook (bid/ask), slippage, funding, open interest, longs/shorts and orderflow
    Research & backtestssignal_statistics_range, signal_statistics, backtest_strategyShows what historically followed a set of indicator conditions, and backtests a long or short strategy with entries, exits, sizing and fees
    Strategieslist_strategies, get_strategy, create_strategy, update_strategy, strategy_config, leverage_rangeLists, reads, creates and edits your saved trading strategies. Saving a strategy never starts trading
    Portfolioportfolio_stats, portfolio_tradesShows your strategy and portfolio results (return, drawdown, Sharpe, win rate, fees) and your closed trades
    Alertslist_alerts, get_alert, alert_history, create_alert, update_alertReads, creates and edits your alerts, and shows when they triggered
    Consoleslist_consoles, get_console, save_consoleReads your saved Console dashboards and saves new ones. A layout you design with your AI shows up on your Terminal
    What you can use depends on your plan. All plans include the MCP. The liquidity tools (Liquidation Heatmap, Liquidation Levels, Net Positions Heatmap) need Advanced or Professional. Historical replay needs Professional. Indicator tiers follow the same rules as the Terminal. If something isn't on your plan, the assistant tells you.

    Set up#

    Cursor#

    Option A: mcp.json
    1.
    Open (or create) ~/.cursor/mcp.json to make Hyblock available in every project, or .cursor/mcp.json inside one project.
    2.
    Add:
    {
      "mcpServers": {
        "hyblock": {
          "url": "https://hyblockcapital.com/api/mcp"
        }
      }
    }
    3.
    Open Customize (MCP settings) in Cursor and turn on hyblock.
    4.
    Cursor opens a Hyblock page in your browser. Sign in to Hyblock and choose Allow.
    5.
    Hyblock's tools now appear under Available Tools. Ask Cursor something like "Use Hyblock to show BTC's liquidation levels on Binance."

    Claude (claude.ai, Claude Desktop and mobile)#

    Remote connectors live in your Claude account, so once you add Hyblock on claude.ai it also works in Claude Desktop and on mobile. Don't add the URL to claude_desktop_config.json. That file is only for local servers.
    1.
    In Claude, go to Customize → Connectors.
    2.
    Click Add, hover over Custom, then select Web.
    3.
    Name it Hyblock and paste https://hyblockcapital.com/api/mcp. Click Continue.
    4.
    Keep the detected OAuth sign-in. Under OAuth client, choose Register automatically. Hyblock supports dynamic client registration, but the code doesn't show support for Claude's "published identity" option. Leave Request headers empty. Click Add.
    5.
    Click Connect, sign in to Hyblock and choose Allow.
    6.
    In a chat, turn on the Hyblock connector from the tools menu and ask away.
    Team and Enterprise plans: an Owner first adds the connector under Organization settings → Connectors. Members then open Customize → Connectors and click Connect.
    Free Claude plans can add one custom connector.

    Claude Code#

    1.
    In a terminal, run:
    Add --scope user to make it available in all your projects.
    2.
    Start claude and run /mcp, or run claude mcp login hyblock from your shell. Your browser opens. Sign in to Hyblock and choose Allow.
    3.
    Run claude mcp list and check that hyblock shows as connected.
    If you already added Hyblock as a connector on claude.ai and you sign in to Claude Code with that Claude account, it shows up in /mcp automatically.

    Codex: Coming soon#

    Support for OpenAI Codex is coming soon. Check back here for setup steps.

    Managing access#

    What you're granting: the assistant acts as your Hyblock account, within your plan. Read tools only read. Tools that save something (strategies, alerts, consoles) ask your AI app for confirmation the way the app normally does. Saving a strategy never turns on live trading.
    Connection limit: each Hyblock account can have up to 3 AI-app connections at once. A 4th sign-in is refused until you remove one.
    Disconnect: remove the server in your AI app. Signing out of Hyblock on all devices also ends every AI-app connection.
    "Reconnect Hyblock" prompts: if your session expires or is signed out, your AI app asks you to sign in again. Choose Allow again to continue.

    Troubleshooting#

    ProblemWhat to do
    "Unable to connect" or "This sign-in request has expired"Sign-in links expire after 10 minutes. Start the connection again from your AI app
    Sign-in refused for your AI appLet us know which app you're using. Hyblock only accepts sign-in callbacks from apps it supports
    "...requires the Advanced/Professional plan"That tool or feature isn't included in your current plan
    Tools don't appear in CursorOpen Output → MCP Logs in Cursor, check that the server is on in Customize, and reconnect
    Modified at 2026-11-05 03:04:18
    Previous
    Authentication(legacy)
    Next
    Orderflow
    Built with