Tool tree
get_site_overviewAnswer
START HERE. Returns a map of this site: what it is, its areas, which tools back each area, common multi-step flows, parameter conventions, and suggested first queries. Call this once to get oriented before using the other tools. This is a read-only analytics dashboard for the Orderly Network perpetual-futures DEX; it does not place trades.
View tool JSON
{
"name": "get_site_overview",
"kind": "answer",
"impl": "imperative",
"description": "START HERE. Returns a map of this site: what it is, its areas, which tools back each area, common multi-step flows, parameter conventions, and suggested first queries. Call this once to get oriented before using the other tools. This is a read-only analytics dashboard for the Orderly Network perpetual-futures DEX; it does not place trades.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_dashboard_mainAnswer
Daily platform totals for Orderly: taker/cumulative volume, revenue (fees), TVL, deposits/withdrawals, new accounts/addresses, and active builders, as a historical time series. For a live snapshot use get_market_summary; for weekly/monthly user aggregates use get_metrics_overview. Returns rows newest-last over the trailing `days` window.
View tool JSON
{
"name": "get_dashboard_main",
"kind": "answer",
"impl": "imperative",
"description": "Daily platform totals for Orderly: taker/cumulative volume, revenue (fees), TVL, deposits/withdrawals, new accounts/addresses, and active builders, as a historical time series. For a live snapshot use get_market_summary; for weekly/monthly user aggregates use get_metrics_overview. Returns rows newest-last over the trailing `days` window.",
"inputSchema": {
"type": "object",
"properties": {
"days": {
"type": "number",
"description": "Trailing days (default 90, max 730)."
}
},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_tvl_by_chainAnswer
Total Value Locked broken down by chain, plus a total row. Drives the TVL By Chain widget. Returns newest snapshot rows.
View tool JSON
{
"name": "get_tvl_by_chain",
"kind": "answer",
"impl": "imperative",
"description": "Total Value Locked broken down by chain, plus a total row. Drives the TVL By Chain widget. Returns newest snapshot rows.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_tvl_by_tokenAnswer
TVL and token balance held per collateral token over a trailing window. Drives the TVL By Token widget.
View tool JSON
{
"name": "get_tvl_by_token",
"kind": "answer",
"impl": "imperative",
"description": "TVL and token balance held per collateral token over a trailing window. Drives the TVL By Token widget.",
"inputSchema": {
"type": "object",
"properties": {
"days": {
"type": "number",
"description": "Trailing days (default 30, max 730)."
}
},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_weekly_symbol_volumeAnswer
Weekly per-symbol volume and listed-markets count from the analytics API. For the live market list (prices, 24h change, open interest) use get_markets.
View tool JSON
{
"name": "get_weekly_symbol_volume",
"kind": "answer",
"impl": "imperative",
"description": "Weekly per-symbol volume and listed-markets count from the analytics API. For the live market list (prices, 24h change, open interest) use get_markets.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_funding_ratesAnswer
8-hour funding rates for every perpetual symbol, from a trailing start date. For cross-exchange funding comparisons use get_funding_comparison.
View tool JSON
{
"name": "get_funding_rates",
"kind": "answer",
"impl": "imperative",
"description": "8-hour funding rates for every perpetual symbol, from a trailing start date. For cross-exchange funding comparisons use get_funding_comparison.",
"inputSchema": {
"type": "object",
"properties": {
"days": {
"type": "number",
"description": "Trailing days for the start date (default 30)."
}
},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_daily_liquidations_by_symbolAnswer
Daily liquidation notional aggregated per perpetual symbol across all markets. For individual recent liquidation events of one symbol use get_recent_liquidations.
View tool JSON
{
"name": "get_daily_liquidations_by_symbol",
"kind": "answer",
"impl": "imperative",
"description": "Daily liquidation notional aggregated per perpetual symbol across all markets. For individual recent liquidation events of one symbol use get_recent_liquidations.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_staking_dailyAnswer
Daily $ORDER staking metrics: staked/unstaked/net amounts, cumulative staker addresses, buybacks, and burned ORDER. Drives the Staking Daily widget.
View tool JSON
{
"name": "get_staking_daily",
"kind": "answer",
"impl": "imperative",
"description": "Daily $ORDER staking metrics: staked/unstaked/net amounts, cumulative staker addresses, buybacks, and burned ORDER. Drives the Staking Daily widget.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_builder_dailyAnswer
Per-builder daily metrics: taker/maker/total volume, active users, broker fees, and net flow. Drives the Builder Volume, Builder Active Traders, Builder Revenue, and Net Flow By Builder widgets.
View tool JSON
{
"name": "get_builder_daily",
"kind": "answer",
"impl": "imperative",
"description": "Per-builder daily metrics: taker/maker/total volume, active users, broker fees, and net flow. Drives the Builder Volume, Builder Active Traders, Builder Revenue, and Net Flow By Builder widgets.",
"inputSchema": {
"type": "object",
"properties": {
"days": {
"type": "number",
"description": "Trailing days (default 30, max 730)."
}
},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_fund_flows_by_brokerAnswer
Daily deposits, withdrawals, and net fund flow per broker. Drives the Net Flow By Builder widget (fund-flow variant).
View tool JSON
{
"name": "get_fund_flows_by_broker",
"kind": "answer",
"impl": "imperative",
"description": "Daily deposits, withdrawals, and net fund flow per broker. Drives the Net Flow By Builder widget (fund-flow variant).",
"inputSchema": {
"type": "object",
"properties": {
"days": {
"type": "number",
"description": "Trailing days (default 30, max 730)."
}
},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_fund_flows_by_chainAnswer
Daily deposits, withdrawals, and net fund flow per chain. Drives the Fund Flows By Chain widget.
View tool JSON
{
"name": "get_fund_flows_by_chain",
"kind": "answer",
"impl": "imperative",
"description": "Daily deposits, withdrawals, and net fund flow per chain. Drives the Fund Flows By Chain widget.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_dex_usersAnswer
Per-builder user activity snapshot: DAU/WAU/MAU with day/week/month-over-month deltas and new-user counts. Drives the DEX Users widget.
View tool JSON
{
"name": "get_dex_users",
"kind": "answer",
"impl": "imperative",
"description": "Per-builder user activity snapshot: DAU/WAU/MAU with day/week/month-over-month deltas and new-user counts. Drives the DEX Users widget.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_metrics_overviewAnswer
Weekly and monthly aggregates for new users, active users, trading volume, and Orderly revenue. For daily historical totals use get_dashboard_main.
View tool JSON
{
"name": "get_metrics_overview",
"kind": "answer",
"impl": "imperative",
"description": "Weekly and monthly aggregates for new users, active users, trading volume, and Orderly revenue. For daily historical totals use get_dashboard_main.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_volume_segmentsAnswer
Weekly trading volume split by market-maker vs retail segment. Drives the Volume Segments widget.
View tool JSON
{
"name": "get_volume_segments",
"kind": "answer",
"impl": "imperative",
"description": "Weekly trading volume split by market-maker vs retail segment. Drives the Volume Segments widget.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_stake_usersAnswer
Weekly average active stakers. Drives the Stake Users widget.
View tool JSON
{
"name": "get_stake_users",
"kind": "answer",
"impl": "imperative",
"description": "Weekly average active stakers. Drives the Stake Users widget.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_stake_vs_supplyAnswer
Weekly ORDER staked vs circulating supply and staking ratio. Drives the Stake vs Supply widget.
View tool JSON
{
"name": "get_stake_vs_supply",
"kind": "answer",
"impl": "imperative",
"description": "Weekly ORDER staked vs circulating supply and staking ratio. Drives the Stake vs Supply widget.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_omnivault_tvlAnswer
Weekly average TVL per OmniVault (USD millions). Drives the OmniVault TVL widget.
View tool JSON
{
"name": "get_omnivault_tvl",
"kind": "answer",
"impl": "imperative",
"description": "Weekly average TVL per OmniVault (USD millions). Drives the OmniVault TVL widget.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_distributor_statsAnswer
Referral distributor statistics: invitee counts, graduated invitees, revenue share, and fee tier. Drives the Distributors widget. Returns an array of distributor rows.
View tool JSON
{
"name": "get_distributor_stats",
"kind": "answer",
"impl": "imperative",
"description": "Referral distributor statistics: invitee counts, graduated invitees, revenue share, and fee tier. Drives the Distributors widget. Returns an array of distributor rows.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_distributor_inviteesAnswer
Per-invitee detail for referral distributors: invite date, DEX, status, and 30D volume/revenue share. Returns an array of invitee rows.
View tool JSON
{
"name": "get_distributor_invitees",
"kind": "answer",
"impl": "imperative",
"description": "Per-invitee detail for referral distributors: invite date, DEX, status, and 30D volume/revenue share. Returns an array of invitee rows.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_market_shareAnswer
Orderly's DEX perpetuals market share vs. other on-chain perp venues, computed from CoinGecko 24h derivatives volume and DefiLlama open interest. Drives the Market Share widget. Returns ranked protocols with volume, open interest, and share %.
View tool JSON
{
"name": "get_market_share",
"kind": "answer",
"impl": "imperative",
"description": "Orderly's DEX perpetuals market share vs. other on-chain perp venues, computed from CoinGecko 24h derivatives volume and DefiLlama open interest. Drives the Market Share widget. Returns ranked protocols with volume, open interest, and share %.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_marketsAnswer
Snapshot of all active perpetual markets: the futures market list, 24h price changes, and per-symbol open interest. Drives the Markets page. Returns an object { markets, priceChanges, openInterest }. Optional search (a case-insensitive substring on the symbol), sort_by (24h_volume | 24h_change | open_interest | symbol), limit (max 200), and desc (default true) filter and rank the markets and trim the priceChanges / openInterest arrays to the same symbol set. Defaults to 50 markets in API order; pass limit: 200 for the full set.
View tool JSON
{
"name": "get_markets",
"kind": "answer",
"impl": "imperative",
"description": "Snapshot of all active perpetual markets: the futures market list, 24h price changes, and per-symbol open interest. Drives the Markets page. Returns an object { markets, priceChanges, openInterest }. Optional search (a case-insensitive substring on the symbol), sort_by (24h_volume | 24h_change | open_interest | symbol), limit (max 200), and desc (default true) filter and rank the markets and trim the priceChanges / openInterest arrays to the same symbol set. Defaults to 50 markets in API order; pass limit: 200 for the full set.",
"inputSchema": {
"type": "object",
"properties": {
"search": {
"type": "string",
"description": "Case-insensitive substring on the symbol (e.g. \"btc\", \"sol\", \"perp_btc\")."
},
"sort_by": {
"type": "string",
"enum": [
"24h_volume",
"24h_change",
"open_interest",
"symbol"
],
"description": "Rank markets by this metric (default: API order)."
},
"limit": {
"type": "number",
"description": "Max markets to return after filter/sort (default 50; max 200)."
},
"desc": {
"type": "boolean",
"description": "Sort descending (default true)."
}
},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_market_detailAnswer
Composite single-symbol bundle for the market detail page. Returns only the requested sections (default: all of market info, top-50 orderbook levels, recent trades, funding history, and OHLCV candles). Requesting fewer sections keeps the payload small. Drives the Price Chart, Orderbook, Recent Trades, and Funding Chart.
View tool JSON
{
"name": "get_market_detail",
"kind": "answer",
"impl": "imperative",
"description": "Composite single-symbol bundle for the market detail page. Returns only the requested sections (default: all of market info, top-50 orderbook levels, recent trades, funding history, and OHLCV candles). Requesting fewer sections keeps the payload small. Drives the Price Chart, Orderbook, Recent Trades, and Funding Chart.",
"inputSchema": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Perp symbol. Accepts a base tick (BTC) or full form (PERP_BTC_USDC)."
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"market_info",
"orderbook",
"recent_trades",
"funding_history",
"candles"
]
},
"description": "Sections to return; omit for all."
},
"candles_interval": {
"type": "string",
"enum": [
"5m",
"15m",
"1h",
"4h",
"1d"
],
"description": "Candle interval (default '1h'). One of: 5m, 15m, 1h, 4h, 1d."
}
},
"required": [
"symbol"
],
"additionalProperties": false
},
"page": "/"
}get_symbol_infoAnswer
Full configuration for a single perpetual symbol: leverage limits (1/base_imr), tick/lot sizes, price precision, and status flags. Returns the symbol info object.
View tool JSON
{
"name": "get_symbol_info",
"kind": "answer",
"impl": "imperative",
"description": "Full configuration for a single perpetual symbol: leverage limits (1/base_imr), tick/lot sizes, price precision, and status flags. Returns the symbol info object.",
"inputSchema": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Perp symbol: base tick (ETH) or full form."
}
},
"required": [
"symbol"
],
"additionalProperties": false
},
"page": "/"
}get_market_summaryAnswer
Live platform-wide market snapshot: 24h volume, open interest, trader counts, and fee totals across all symbols. For historical daily time series use get_dashboard_main; for weekly/monthly user aggregates use get_metrics_overview.
View tool JSON
{
"name": "get_market_summary",
"kind": "answer",
"impl": "imperative",
"description": "Live platform-wide market snapshot: 24h volume, open interest, trader counts, and fee totals across all symbols. For historical daily time series use get_dashboard_main; for weekly/monthly user aggregates use get_metrics_overview.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_funding_comparisonAnswer
Cross-exchange funding rate comparison: last value plus 1d/7d/30d averages per symbol across venues (Orderly vs. Binance, Bybit, etc.). Omit symbol for all symbols. For per-symbol 8h funding history use get_funding_rates.
View tool JSON
{
"name": "get_funding_comparison",
"kind": "answer",
"impl": "imperative",
"description": "Cross-exchange funding rate comparison: last value plus 1d/7d/30d averages per symbol across venues (Orderly vs. Binance, Bybit, etc.). Omit symbol for all symbols. For per-symbol 8h funding history use get_funding_rates.",
"inputSchema": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Perp symbol: base tick (BTC) or full form; omit for all."
}
},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_recent_liquidationsAnswer
Recent individual liquidation events for one symbol: side, size, notional, mark/liquidation price, and the liquidated account. For daily liquidation totals aggregated across all symbols use get_daily_liquidations_by_symbol.
View tool JSON
{
"name": "get_recent_liquidations",
"kind": "answer",
"impl": "imperative",
"description": "Recent individual liquidation events for one symbol: side, size, notional, mark/liquidation price, and the liquidated account. For daily liquidation totals aggregated across all symbols use get_daily_liquidations_by_symbol.",
"inputSchema": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Perp symbol: base tick (BTC) or full form (PERP_BTC_USDC)."
},
"limit": {
"type": "number",
"description": "Max events (default 50, max 500)."
}
},
"required": [
"symbol"
],
"additionalProperties": false
},
"page": "/"
}get_top_tradersAnswer
Top addresses ranked by a chosen metric (notional, volume, PnL, or trade count) for a symbol or platform-wide. Paginated via cursor. Drives the Top Traders panel and Whale Leaderboard.
View tool JSON
{
"name": "get_top_traders",
"kind": "answer",
"impl": "imperative",
"description": "Top addresses ranked by a chosen metric (notional, volume, PnL, or trade count) for a symbol or platform-wide. Paginated via cursor. Drives the Top Traders panel and Whale Leaderboard.",
"inputSchema": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Perp symbol: base tick (BTC) or full form; omit for platform-wide."
},
"sort_by": {
"type": "string",
"enum": [
"notional",
"volume_24h",
"volume_7d",
"volume_30d",
"pnl_24h",
"pnl_7d",
"pnl_30d",
"trade_count_24h"
],
"description": "Ranking metric (default notional)."
},
"min_notional": {
"type": "number",
"description": "Minimum notional filter (default 0)."
},
"limit": {
"type": "number",
"description": "Page size (default 50, max 200)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor from a previous response — pass it back unchanged."
}
},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_whale_contextAnswer
Whale research bundle for a single address: account state (collateral, PnL), open positions, and recent trades. Requires an address; optionally scope to a broker or account_id. Drives the Whale Detail modal.
View tool JSON
{
"name": "get_whale_context",
"kind": "answer",
"impl": "imperative",
"description": "Whale research bundle for a single address: account state (collateral, PnL), open positions, and recent trades. Requires an address; optionally scope to a broker or account_id. Drives the Whale Detail modal.",
"inputSchema": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Wallet address (EVM 0x…)."
},
"broker_id": {
"type": "string",
"description": "Broker to scope to (optional)."
},
"account_id": {
"type": "string",
"description": "Account ID to scope to (optional)."
},
"recent_trades_limit": {
"type": "number",
"description": "Max trades (default 20, max 100)."
}
},
"required": [
"address"
],
"additionalProperties": false
},
"page": "/"
}get_platform_positionsAnswer
Platform-wide open positions for a symbol (large-position liquidation-heatmap data). Returns up to 1000 positions filtered by minimum notional. Drives the Liquidation Heatmap.
View tool JSON
{
"name": "get_platform_positions",
"kind": "answer",
"impl": "imperative",
"description": "Platform-wide open positions for a symbol (large-position liquidation-heatmap data). Returns up to 1000 positions filtered by minimum notional. Drives the Liquidation Heatmap.",
"inputSchema": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Perp symbol: base tick (BTC) or full form."
},
"min_notional": {
"type": "number",
"description": "Minimum position notional (default 0)."
}
},
"required": [
"symbol"
],
"additionalProperties": false
},
"page": "/"
}get_insurance_fundAnswer
Orderly insurance fund balance, holdings, and status. Drives the Insurance Fund widget.
View tool JSON
{
"name": "get_insurance_fund",
"kind": "answer",
"impl": "imperative",
"description": "Orderly insurance fund balance, holdings, and status. Drives the Insurance Fund widget.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_leaderboardAnswer
Daily trading leaderboard: realized PnL and perp volume per trader over a date range (YYYY-MM-DD). Supports pagination, broker/address filters, sort, and aggregation by address, account, or date. Drives the Leaderboard (trading) tab.
View tool JSON
{
"name": "get_leaderboard",
"kind": "answer",
"impl": "imperative",
"description": "Daily trading leaderboard: realized PnL and perp volume per trader over a date range (YYYY-MM-DD). Supports pagination, broker/address filters, sort, and aggregation by address, account, or date. Drives the Leaderboard (trading) tab.",
"inputSchema": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"description": "Inclusive start, YYYY-MM-DD."
},
"end_date": {
"type": "string",
"description": "Inclusive end, YYYY-MM-DD."
},
"page": {
"type": "number",
"description": "1-based page (default 1)."
},
"size": {
"type": "number",
"description": "Page size (default 20, max 100)."
},
"sort": {
"type": "string",
"enum": [
"ascending_realized_pnl",
"descending_realized_pnl",
"ascending_perp_volume",
"descending_perp_volume"
],
"description": "Default descending_realized_pnl."
},
"broker_id": {
"type": "string"
},
"address": {
"type": "string",
"description": "Filter to a wallet address."
},
"aggregateBy": {
"type": "string",
"enum": [
"address",
"address_per_builder",
"date",
"account"
]
}
},
"required": [
"start_date",
"end_date"
],
"additionalProperties": false
},
"page": "/"
}get_positionsAnswer
Open-positions leaderboard: largest open positions by notional, optionally filtered by account, broker, or symbol. Drives the Leaderboard (positions) tab.
View tool JSON
{
"name": "get_positions",
"kind": "answer",
"impl": "imperative",
"description": "Open-positions leaderboard: largest open positions by notional, optionally filtered by account, broker, or symbol. Drives the Leaderboard (positions) tab.",
"inputSchema": {
"type": "object",
"properties": {
"account_id": {
"type": "string"
},
"broker_id": {
"type": "string"
},
"symbol": {
"type": "string",
"description": "Perp symbol: base tick (BTC) or full form (PERP_BTC_USDC)."
},
"offset": {
"type": "number",
"description": "Pagination offset (default 0)."
},
"limit": {
"type": "number",
"description": "Page size (default 50, max 500)."
},
"order_by": {
"type": "string",
"enum": [
"ASC",
"DESC"
],
"description": "Default DESC."
}
},
"required": [],
"additionalProperties": false
},
"page": "/"
}resolve_addressAction
Resolve a wallet address or account ID into its Orderly broker/account pairs. Accepts an EVM address (0x + 40 hex), a Solana address (43-44 base58 chars), or an account ID (0x + 64 hex). Returns an array of {broker_id, account_id, …} pairs for the identity. For address queries (not account IDs) each account is enriched with 90-day perp_volume and realized_pnl, sorted by volume descending — matching the Search results page. First step of the Explorer/address flow.
View tool JSON
{
"name": "resolve_address",
"kind": "act",
"impl": "imperative",
"description": "Resolve a wallet address or account ID into its Orderly broker/account pairs. Accepts an EVM address (0x + 40 hex), a Solana address (43-44 base58 chars), or an account ID (0x + 64 hex). Returns an array of {broker_id, account_id, …} pairs for the identity. For address queries (not account IDs) each account is enriched with 90-day perp_volume and realized_pnl, sorted by volume descending — matching the Search results page. First step of the Explorer/address flow.",
"inputSchema": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "EVM address, Solana address, or Orderly account ID."
}
},
"required": [
"address"
],
"additionalProperties": false
},
"page": "/"
}get_eventsAnswer
Historical trading events for an account: trades, settlements, liquidations, ADLs, and margin transfers (versioned v1/v2/v3 already flattened to a uniform shape). Time range is capped at 31 days; omit both times for the most recent page. Drives the address Events tab. Returns { events, nextCursor, pageSizeLimit, tradesCount }; pass the nextCursor back as the cursor param to fetch the next page.
View tool JSON
{
"name": "get_events",
"kind": "answer",
"impl": "imperative",
"description": "Historical trading events for an account: trades, settlements, liquidations, ADLs, and margin transfers (versioned v1/v2/v3 already flattened to a uniform shape). Time range is capped at 31 days; omit both times for the most recent page. Drives the address Events tab. Returns { events, nextCursor, pageSizeLimit, tradesCount }; pass the nextCursor back as the cursor param to fetch the next page.",
"inputSchema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"description": "Orderly account ID (0x + 64 hex)."
},
"event_type": {
"type": "string",
"enum": [
"TRANSACTION",
"PERPTRADE",
"SETTLEMENT",
"LIQUIDATION",
"ADL",
"MARGINTRANSFER"
]
},
"from_time": {
"type": "number",
"description": "Inclusive start, Unix seconds."
},
"to_time": {
"type": "number",
"description": "Inclusive end, Unix seconds."
},
"cursor": {
"type": "object",
"additionalProperties": true,
"description": "Opaque pagination cursor (the nextCursor value from a prior response). Do not construct this object yourself — only pass back the cursor you received."
}
},
"required": [
"account_id"
],
"additionalProperties": false
},
"page": "/"
}get_account_stateAnswer
Account snapshot for an address: collateral, margin ratios, 24h PnL, and all OPEN positions (qty, notional, entry/mark price, leverage, est. liquidation price). Drives the address Positions tab.
View tool JSON
{
"name": "get_account_state",
"kind": "answer",
"impl": "imperative",
"description": "Account snapshot for an address: collateral, margin ratios, 24h PnL, and all OPEN positions (qty, notional, entry/mark price, leverage, est. liquidation price). Drives the address Positions tab.",
"inputSchema": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Wallet address (EVM 0x…)."
},
"broker_id": {
"type": "string"
},
"account_id": {
"type": "string"
}
},
"required": [
"address"
],
"additionalProperties": false
},
"page": "/"
}get_portfolioAnswer
Daily account-value time series with cumulative PnL (equity curve) for an address, up to 365 days. Drives the Portfolio Chart on the address page.
View tool JSON
{
"name": "get_portfolio",
"kind": "answer",
"impl": "imperative",
"description": "Daily account-value time series with cumulative PnL (equity curve) for an address, up to 365 days. Drives the Portfolio Chart on the address page.",
"inputSchema": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Wallet address (EVM 0x…)."
},
"broker_id": {
"type": "string"
},
"account_id": {
"type": "string"
},
"start_time": {
"type": "number",
"description": "Inclusive start, Unix seconds."
},
"end_time": {
"type": "number",
"description": "Inclusive end, Unix seconds."
},
"limit": {
"type": "number",
"description": "Max snapshots (default 90, max 365)."
}
},
"required": [
"address"
],
"additionalProperties": false
},
"page": "/"
}get_brokersAnswer
Directory of all Orderly brokers (broker_id → human-readable broker_name), sorted by name. Use to label broker_id values returned by other tools.
View tool JSON
{
"name": "get_brokers",
"kind": "answer",
"impl": "imperative",
"description": "Directory of all Orderly brokers (broker_id → human-readable broker_name), sorted by name. Use to label broker_id values returned by other tools.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_all_symbolsAnswer
Every known perp symbol (including delisted) as a hash→name map: {symbol, symbol_hash}. Use to resolve keccak256 symbol hashes in event/position data to display names. Active symbols are also available via get_markets.
View tool JSON
{
"name": "get_all_symbols",
"kind": "answer",
"impl": "imperative",
"description": "Every known perp symbol (including delisted) as a hash→name map: {symbol, symbol_hash}. Use to resolve keccak256 symbol hashes in event/position data to display names. Active symbols are also available via get_markets.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_all_tokensAnswer
Every known settlement/collateral token as a hash→name map: {token, token_hash}. Use to resolve keccak256 token hashes in settlement/fee fields to display names.
View tool JSON
{
"name": "get_all_tokens",
"kind": "answer",
"impl": "imperative",
"description": "Every known settlement/collateral token as a hash→name map: {token, token_hash}. Use to resolve keccak256 token hashes in settlement/fee fields to display names.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}open_marketAction
Navigate the user to a market detail page. Pass a base tick (BTC), the full form (PERP_BTC_USDC), or a broker-suffixed variant (PERP_AAPL_USDC_mythos). The page renders a graceful "Market Not Found" for unknown symbols, so no pre-validation is performed — the user lands on the right place regardless.
View tool JSON
{
"name": "open_market",
"kind": "act",
"impl": "imperative",
"description": "Navigate the user to a market detail page. Pass a base tick (BTC), the full form (PERP_BTC_USDC), or a broker-suffixed variant (PERP_AAPL_USDC_mythos). The page renders a graceful \"Market Not Found\" for unknown symbols, so no pre-validation is performed — the user lands on the right place regardless.",
"inputSchema": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Market symbol (e.g. BTC, ETH, PERP_BTC_USDC)."
}
},
"required": [
"symbol"
],
"additionalProperties": false
},
"page": "/"
}open_addressAction
Navigate the user to an address / account detail page. Accepts an EVM address (0x + 40 hex), an Orderly account_id (0x + 64 hex), or a Solana base58 address. Solana addresses are url-safe-base64 encoded to match in-app AddressLink links.
View tool JSON
{
"name": "open_address",
"kind": "act",
"impl": "imperative",
"description": "Navigate the user to an address / account detail page. Accepts an EVM address (0x + 40 hex), an Orderly account_id (0x + 64 hex), or a Solana base58 address. Solana addresses are url-safe-base64 encoded to match in-app AddressLink links.",
"inputSchema": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "EVM address, Solana address, or Orderly account_id."
}
},
"required": [
"address"
],
"additionalProperties": false
},
"page": "/"
}focus_widgetAction
Scroll a dashboard widget into the user's view and highlight it briefly. Only widgets present on the current page can be focused (widgets render on specific pages, not everywhere). Use get_site_overview to learn which widgets live where.
View tool JSON
{
"name": "focus_widget",
"kind": "act",
"impl": "imperative",
"description": "Scroll a dashboard widget into the user's view and highlight it briefly. Only widgets present on the current page can be focused (widgets render on specific pages, not everywhere). Use get_site_overview to learn which widgets live where.",
"inputSchema": {
"type": "object",
"properties": {
"widget_id": {
"type": "string",
"enum": [
"volume",
"tvl-chain",
"net-fees",
"overview",
"dex-users",
"market-share",
"volume-segments",
"omnivault-tvl",
"stake-users",
"stake-vs-supply",
"distributors",
"fees-stats",
"builder-volume",
"builder-active-traders",
"builder-revenue",
"net-flow-by-builder",
"tvl-by-token",
"leaderboard",
"positions",
"kpi-analyst",
"funding-comparison",
"funding-rates",
"staking-daily",
"fund-flows-by-chain",
"liquidations-by-symbol",
"liquidation-heatmap",
"insurance-fund",
"market-price-chart",
"market-orderbook",
"market-recent-trades",
"market-funding-chart",
"market-recent-liquidations",
"market-top-traders",
"market-platform-positions"
],
"description": "Widget id to focus."
}
},
"required": [
"widget_id"
],
"additionalProperties": false
},
"page": "/"
}share_widgetAction
Open the share dialog for a dashboard widget, presenting the user with the widget's embed/share link. Only works when the widget and its share button are rendered on the current page (share buttons are hidden on embeds).
View tool JSON
{
"name": "share_widget",
"kind": "act",
"impl": "imperative",
"description": "Open the share dialog for a dashboard widget, presenting the user with the widget's embed/share link. Only works when the widget and its share button are rendered on the current page (share buttons are hidden on embeds).",
"inputSchema": {
"type": "object",
"properties": {
"widget_id": {
"type": "string",
"enum": [
"volume",
"tvl-chain",
"net-fees",
"overview",
"dex-users",
"market-share",
"volume-segments",
"omnivault-tvl",
"stake-users",
"stake-vs-supply",
"distributors",
"fees-stats",
"builder-volume",
"builder-active-traders",
"builder-revenue",
"net-flow-by-builder",
"tvl-by-token",
"leaderboard",
"positions",
"kpi-analyst",
"funding-comparison",
"funding-rates",
"staking-daily",
"fund-flows-by-chain",
"liquidations-by-symbol",
"liquidation-heatmap",
"insurance-fund",
"market-price-chart",
"market-orderbook",
"market-recent-trades",
"market-funding-chart",
"market-recent-liquidations",
"market-top-traders",
"market-platform-positions"
],
"description": "Widget id to share."
}
},
"required": [
"widget_id"
],
"additionalProperties": false
},
"page": "/"
}get_current_viewAnswer
Read-only snapshot of what the user is currently looking at: the current route/URL, the page area, the active market symbol (base tick) when on a market page, and the list of widget ids currently rendered on screen (valid inputs for focus_widget / share_widget / get_widget_url). Call this to ground yourself in the user's current view before navigating or pointing at a widget. After open_market or open_address, call this to confirm the destination rendered — the result includes a status (loading | ready | not-found | error) and, when available, a short summary.
View tool JSON
{
"name": "get_current_view",
"kind": "answer",
"impl": "imperative",
"description": "Read-only snapshot of what the user is currently looking at: the current route/URL, the page area, the active market symbol (base tick) when on a market page, and the list of widget ids currently rendered on screen (valid inputs for focus_widget / share_widget / get_widget_url). Call this to ground yourself in the user's current view before navigating or pointing at a widget. After open_market or open_address, call this to confirm the destination rendered — the result includes a status (loading | ready | not-found | error) and, when available, a short summary.",
"inputSchema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
},
"page": "/"
}get_widget_urlAnswer
Return the embeddable share URL for a dashboard widget — the same link the Share dialog produces — without opening any UI. Use this to give the user a link to a widget. Market widgets (market-*) take an optional symbol.
View tool JSON
{
"name": "get_widget_url",
"kind": "answer",
"impl": "imperative",
"description": "Return the embeddable share URL for a dashboard widget — the same link the Share dialog produces — without opening any UI. Use this to give the user a link to a widget. Market widgets (market-*) take an optional symbol.",
"inputSchema": {
"type": "object",
"properties": {
"widget_id": {
"type": "string",
"enum": [
"volume",
"tvl-chain",
"net-fees",
"overview",
"dex-users",
"market-share",
"volume-segments",
"omnivault-tvl",
"stake-users",
"stake-vs-supply",
"distributors",
"fees-stats",
"builder-volume",
"builder-active-traders",
"builder-revenue",
"net-flow-by-builder",
"tvl-by-token",
"leaderboard",
"positions",
"kpi-analyst",
"funding-comparison",
"funding-rates",
"staking-daily",
"fund-flows-by-chain",
"liquidations-by-symbol",
"liquidation-heatmap",
"insurance-fund",
"market-price-chart",
"market-orderbook",
"market-recent-trades",
"market-funding-chart",
"market-recent-liquidations",
"market-top-traders",
"market-platform-positions"
],
"description": "Widget id to get a link for."
},
"symbol": {
"type": "string",
"description": "Symbol for market widgets (e.g. BTC). Ignored for non-market widgets."
}
},
"required": [
"widget_id"
],
"additionalProperties": false
},
"page": "/"
}