| add_tracked_address |
Call this when the user asks to follow, track or get alerts for a Hyperliquid address (0x followed by 40 hex characters). |
2 |
1 |
none |
idempotent |
0 |
| add_watchlist_symbol |
Call this when the user asks to watch, follow or add a coin to their watchlist. |
2 |
1 |
none |
idempotent |
1 |
| create_alert_recipe |
Call this when the user asks to be alerted when a metric crosses a threshold and has agreed to the exact condition (parse_alert_text turns their words into one). |
9 |
0 |
none |
|
1 |
| delete_alert_recipe |
Call this when the user asks to remove an alert. |
1 |
1 |
none |
destructive · idempotent |
1 |
| get_altseason |
Call this when the user asks whether it is altseason, how altcoins are doing against Bitcoin, or about market rotation. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_borrow_rates |
Call this when the user asks what it costs to borrow USDT, USDC, BTC, ETH or a major alt on an exchange, which venue has the cheapest borrow, whether stablecoin borrow cost is spik… |
2 |
0 |
none |
readOnly · openWorld |
1 |
| get_coinbase_premium |
Call this when the user asks whether US investors are buying or selling Bitcoin or Ethereum, about the Coinbase Premium, or what the cash-and-carry basis trade pays. |
1 |
0 |
none |
readOnly · openWorld |
1 |
| get_correlations |
Call this when the user asks how correlated two coins are, for decorrelated pairs, or how tightly alts track BTC. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_cot_positioning |
Call this when the user asks how hedge funds or institutions are positioned in Bitcoin or Ethereum, or about the CFTC Commitments of Traders report. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_coverage |
Call this when the user asks which exchanges sit behind a ByKaranteli number, whether a feed is complete or sampled, since when a venue is collected, or how fresh the data is. |
1 |
0 |
none |
readOnly · openWorld |
2 |
| get_cycle_indicators |
Call this when the user asks whether Bitcoin is near a cycle top or bottom by the classic indicators, about the Pi Cycle Top, Mayer Multiple, 200-week moving average, 2-year MA mul… |
2 |
0 |
none |
readOnly · openWorld |
0 |
| get_data_proof |
Call this when the user asks whether ByKaranteli data can be verified or was changed afterwards, about the BYK Data Layer, on-chain proofs of market data, or wants the proof behind… |
4 |
0 |
none |
readOnly · openWorld |
3 |
| get_desk_notes |
Call this when the user asks what happened in crypto derivatives today or on a date, what the desk observed, what moved in funding, open interest, liquidations, options, ETF flows … |
5 |
0 |
none |
readOnly · openWorld |
0 |
| get_etf_flows |
Call this when the user asks about Bitcoin, Ethereum, Solana or XRP spot ETF flows: daily net inflows or outflows, cumulative flow since launch, or total net assets of the US spot … |
2 |
0 |
none |
readOnly · openWorld |
1 |
| get_factor_board |
Call this when the user asks which indicators currently sit in an unusual band, whether a metric's current level historically preceded BTC moves, or for a cross-metric conditional … |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_fee_table |
Call this when the user asks what an exchange charges to trade, how maker and taker fees compare across venues, whether a venue changed its fees, or what a round trip costs on a gi… |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_flow_toxicity |
Call this when the user asks whether informed or toxic order flow is building, about VPIN, or whether market makers are under pressure in Bitcoin, Ethereum or Solana. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_fomc_impact |
Call this when the user asks what Bitcoin does on Fed days, how FOMC statements move crypto, or when the next FOMC meeting is. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_funding_arbitrage |
Call this when the user asks about funding arbitrage, funding rate differences between exchanges, or delta-neutral carry trades. |
1 |
0 |
none |
readOnly · openWorld |
2 |
| get_funding_heatmap |
Call this when the user asks for the full current funding table across the ~30 most traded Binance perps (28-30 rows; contracts without a live funding print are skipped), or the fu… |
1 |
0 |
none |
readOnly · openWorld |
0 |
| get_hl_positions |
Call this when the user asks where Hyperliquid whales would be liquidated, how much tracked notional sits at each price, how the largest accounts lean on a coin, or how their liqui… |
2 |
0 |
none |
readOnly · openWorld |
0 |
| get_hl_whales |
Call this when the user asks what Hyperliquid whales are doing, whether the biggest Hyperliquid accounts are net long or short a coin, for the largest open positions with liquidati… |
3 |
0 |
none |
readOnly · openWorld |
1 |
| get_insurance_funds |
Call this when the user asks how big an exchange's insurance fund is, whether a fund is shrinking or was used after a crash, how much exchanges hold to absorb bankrupt liquidations… |
3 |
0 |
none |
readOnly · openWorld |
0 |
| get_iv_surface |
Call this when the user asks about implied volatility by strike or expiry, skew, put versus call IV, term structure of IV, or whether downside protection is expensive. |
1 |
0 |
none |
readOnly · openWorld |
0 |
| get_jupiter_perps |
Call this when the user asks about Jupiter perpetuals on Solana: long versus short open interest per market (SOL, ETH, BTC) read from the on-chain custody state, pool utilization a… |
2 |
0 |
none |
readOnly · openWorld |
0 |
| get_lead_lag |
Call this when the user asks which exchange leads price discovery or whether spot or perp moves first. |
1 |
0 |
none |
readOnly · openWorld |
1 |
| get_leverage_tiers |
Call this when the user asks how much leverage an exchange allows on a coin, what the maintenance margin or risk limit ladder is, which venue offers the highest leverage for a symb… |
3 |
0 |
none |
readOnly · openWorld |
1 |
| get_liqmap |
Call this when the user asks where liquidation clusters or liquidity pools sit for a perpetual, where leveraged longs/shorts would get liquidated, or for a liquidation heatmap read… |
3 |
0 |
none |
readOnly · openWorld |
3 |
| get_liquidation_cascades |
Call this when the user asks what caused a recent crash or flush, about liquidation cascades, or who got liquidated. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_liquidation_leaderboard |
Call this when the user asks for the biggest liquidation today or this week, who got liquidated for the most, the largest single liquidation print, or when in the day or week liqui… |
3 |
0 |
none |
readOnly · openWorld |
0 |
| get_liquidations |
Call this when the user asks how much was liquidated in crypto futures, whether longs or shorts got flushed, or for liquidation history. |
3 |
0 |
none |
readOnly · openWorld |
2 |
| get_macro_liquidity |
Call this when the user asks about macro liquidity, the Fed balance sheet, reverse repo, rates or stablecoin supply in relation to crypto. |
2 |
0 |
none |
readOnly · openWorld |
1 |
| get_market_indices |
Call this when the user asks about overall crypto market sentiment or macro state: the Fear & Greed index (today and yesterday), Bitcoin dominance percentage, total market cap, or … |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_market_profile |
Call this when the user asks about a perpetual's Market Profile, TPO profile, point of control (POC), value area (VAH, VAL), initial balance or naked (untested) points of control. |
2 |
0 |
none |
readOnly · openWorld |
0 |
| get_metric_context |
Call this when the user asks whether a metric's current reading is high or low, or what happened after similar readings. |
1 |
1 |
none |
readOnly · openWorld |
0 |
| get_network_health |
Call this when the user asks about Bitcoin hashrate, difficulty or block fees (our node runs blocksonly, so there is no mempool series). |
2 |
0 |
none |
readOnly · openWorld |
2 |
| get_new_listings |
Call this when the user asks what new perpetuals were listed, which exchange listed a coin first, or about delistings. |
1 |
0 |
none |
readOnly · openWorld |
1 |
| get_open_interest |
Call this when the user asks whether leverage is entering or leaving the market, about open interest changes, or whether longs or shorts are building in a major coin. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_options_chain |
Call this when the user asks how the BTC or ETH option chain moved today or over the last day: open interest and mark IV per expiry and strike from ByKaranteli's own hourly capture… |
4 |
0 |
none |
readOnly · openWorld |
1 |
| get_options_flow |
Call this when the user asks what big options players are buying, about block trades, or whether call or put premium dominates today. |
0 |
0 |
none |
readOnly · openWorld |
1 |
| get_options_snapshot |
Call this when the user asks where the big options bets sit, about call/put walls, gamma exposure (GEX), the zero-gamma level, implied volatility (DVOL) or the IV term structure fo… |
1 |
0 |
none |
readOnly · openWorld |
2 |
| get_orderbook_depth |
Call this when the user asks where the bid or ask walls are, how deep the spot order book is, whether buyers or sellers have more resting orders near price, or for an order book he… |
2 |
0 |
none |
readOnly · openWorld |
1 |
| get_positioning |
Call this when the user asks about the long/short ratio, whether retail or top traders are net long or short, the taker buy/sell ratio, or CVD (cumulative volume delta) for a perpe… |
3 |
0 |
none |
readOnly · openWorld |
3 |
| get_pressure_scores |
Call this when the user asks which coins are crowded or over-leveraged, or asks for the pressure/derivatives-stress score of specific coins. |
2 |
0 |
none |
readOnly · openWorld |
0 |
| get_psi_charge |
Call this when the user asks about the market's hidden liquidity state, PsiCharge, or whether parked money is deploying or stress is unwinding. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_quantum_exposure |
Call this when the user asks how much Bitcoin is vulnerable to a quantum computer, about quantum-exposed supply, P2PK coins, or Satoshi-era exposure. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_rsi_heatmap |
Call this when the user asks which coins are overbought or oversold, for a crypto RSI heatmap, multi-timeframe RSI, or one contract's RSI on 15m, 1h, 4h, 12h, 1d, 3d, 1w or 1M. |
5 |
0 |
none |
readOnly · openWorld |
1 |
| get_series |
Call this when the user wants the history of one recorded metric for one perpetual as a time series: price candles, volume, perp or spot CVD, open interest, funding (one venue, or … |
7 |
1 |
none |
readOnly · openWorld |
2 |
| get_settlements |
Call this when the user asks what futures or options expire soon, when the next quarterly expiry is on an exchange, how many contracts settle this week, or at what price a dated fu… |
2 |
0 |
none |
readOnly · openWorld |
1 |
| get_slippage |
Call this when the user asks how much slippage a trade of a given size would face, how thick the books are, or which major perp market is thinnest right now. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_solana_perps |
Call this when the user asks about perpetuals on Solana as a whole, which Solana perp DEX has the most open interest or volume, a market on Pacifica, Phoenix, GM Trade (GMX on Sola… |
4 |
0 |
none |
readOnly · openWorld |
1 |
| get_theme_indices |
Call this when the user asks which crypto narrative or sector is leading, about rotation between AI, RWA, DePIN, memecoins, layer 1, layer 2, DeFi or quantum coins, or for a theme … |
1 |
0 |
none |
readOnly · openWorld |
0 |
| get_tokenized_stocks |
Call this when the user asks about tokenized stocks or stock tokens (xStocks, Ondo, Robinhood stock tokens, Coinbase tokenized stocks on Base, Binance bStocks, Backpack, Gate gStoc… |
4 |
0 |
none |
readOnly · openWorld |
5 |
| get_top_movers |
Call this when the user asks what is moving in crypto derivatives right now, which coins have the biggest open interest changes, the most extreme funding, the widest basis, or the … |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_tradfi_board |
Call this when the user asks about stock perpetuals (TSLA, NVDA, AAPL, gold, S&P 500...), tokenized-equity perps, TradFi perp funding rates, open interest, liquidations, which exch… |
3 |
0 |
none |
readOnly · openWorld |
1 |
| get_tradfi_gaps |
Call this when the user asks what a stock, index or commodity perpetual did over the weekend or overnight while the cash market was closed, how far it sat from the last cash close … |
3 |
0 |
none |
readOnly · openWorld |
1 |
| get_turkey_premium |
Call this when the user asks about Bitcoin, Ether or USDT prices in Turkish lira, the Turkey premium, the USDT/TRY rate or dollar premium in Turkey, or which Turkish exchanges (Btc… |
3 |
0 |
none |
readOnly · openWorld |
4 |
| get_venue_markets |
Call this when the user asks about total open interest across exchanges, which venues hold the most OI, DEX versus CEX share, funding dispersion between venues, or stablecoin pegs. |
3 |
0 |
none |
readOnly · openWorld |
2 |
| get_venue_profile |
Call this when the user asks about a specific exchange (Bybit, OKX, Gate, KuCoin, HTX, Bitget, MEXC, BitMEX, Hyperliquid ...): how many contracts it lists, its perp open interest a… |
1 |
0 |
none |
readOnly · openWorld |
0 |
| get_venue_share |
Call this when the user asks which exchange sees the most liquidations, how that share moved this week or this month, or how perpetual open interest splits between venues. |
1 |
0 |
none |
readOnly · openWorld |
0 |
| get_whale_tape |
Call this when the user asks about whale trades, large market orders, or whether big players are buying or selling right now. |
0 |
0 |
none |
readOnly · openWorld |
0 |
| get_withdrawal_status |
Call this when the user asks whether an exchange has paused withdrawals or deposits, which networks are open for an asset, what the withdrawal fee or minimum is on each venue, or w… |
3 |
0 |
none |
readOnly · openWorld |
1 |
| list_alert_recipes |
Call this when the user asks which alerts they have, whether an alert fired, or before deleting or changing one. |
0 |
0 |
none |
readOnly |
1 |
| list_tracked_addresses |
Call this when the user asks which Hyperliquid addresses they follow, or what those addresses hold right now. |
0 |
0 |
none |
readOnly |
0 |
| list_watchlists |
Call this when the user asks what is on their watchlist, which lists they have, or before adding or removing a symbol. |
1 |
0 |
none |
readOnly |
1 |
| parse_alert_text |
Call this when the user describes an alert in words ("tell me when ETH drops 5% in a day", "BTC funding above 5 bps", "liquidations over $20M in an hour") and you want the exact re… |
1 |
1 |
none |
readOnly |
0 |
| remove_tracked_address |
Call this when the user asks to stop following or tracking a Hyperliquid address. |
1 |
1 |
none |
destructive · idempotent |
0 |
| remove_watchlist_symbol |
Call this when the user asks to stop watching a coin or remove it from their watchlist. |
2 |
1 |
none |
destructive · idempotent |
1 |