Orderly Dashboard

Ask an agent to

• Show Orderly's TVL broken down by chain
• Get the latest funding rates for BTC perps
• Show daily liquidations by symbol this week

45 tools

• focus_widget

  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…

  widget_id: string

• get_account_stateread-only

  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.

  address: string, broker_id: string?, account_id: string?

• get_all_symbolsread-only

  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.

• get_all_tokensread-only

  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.

• get_brokersread-only

  Directory of all Orderly brokers (broker_id → human-readable broker_name), sorted by name. Use to label broker_id values returned by other tools.

• get_builder_dailyread-only

  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.

  days: number?

• get_current_viewread-only

  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…

• get_daily_liquidations_by_symbolread-only

  Daily liquidation notional aggregated per perpetual symbol across all markets. For individual recent liquidation events of one symbol use get_recent_liquidations.

• get_dashboard_mainread-only

  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…

  days: number?

• get_dex_usersread-only

  Per-builder user activity snapshot: DAU/WAU/MAU with day/week/month-over-month deltas and new-user counts. Drives the DEX Users widget.

• get_distributor_inviteesread-only

  Per-invitee detail for referral distributors: invite date, DEX, status, and 30D volume/revenue share. Returns an array of invitee rows.

• get_distributor_statsread-only

  Referral distributor statistics: invitee counts, graduated invitees, revenue share, and fee tier. Drives the Distributors widget. Returns an array of distributor rows.

• get_eventsread-only

  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…

  account_id: string, event_type: string?, from_time: number?, to_time: number?, cursor: object?

• get_fund_flows_by_brokerread-only

  Daily deposits, withdrawals, and net fund flow per broker. Drives the Net Flow By Builder widget (fund-flow variant).

  days: number?

• get_fund_flows_by_chainread-only

  Daily deposits, withdrawals, and net fund flow per chain. Drives the Fund Flows By Chain widget.

• get_funding_comparisonread-only

  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…

  symbol: string?

• get_funding_ratesread-only

  8-hour funding rates for every perpetual symbol, from a trailing start date. For cross-exchange funding comparisons use get_funding_comparison.

  days: number?

• get_insurance_fundread-only

  Orderly insurance fund balance, holdings, and status. Drives the Insurance Fund widget.

• get_leaderboardread-only

  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…

  start_date: string, end_date: string, page: number?, size: number?, sort: string?, broker_id: string?, address: string?, aggregateBy: string?, … (list cut; the site may define more)

• get_market_detailread-only

  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…

  symbol: string, include: array?, candles_interval: string?

• get_market_shareread-only

  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…

• get_market_summaryread-only

  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_marketsread-only

  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 }. Each market row…

  search: string?, sort_by: string?, limit: number?, desc: boolean?

• get_metrics_overviewread-only

  Weekly and monthly aggregates for new users, active users, trading volume, and Orderly revenue. For daily historical totals use get_dashboard_main.

• get_omnivault_tvlread-only

  Weekly average TVL per OmniVault (USD millions). Drives the OmniVault TVL widget.

• get_platform_positionsread-only

  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.

  symbol: string, min_notional: number?

• get_portfolioread-only

  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.

  address: string, broker_id: string?, account_id: string?, start_time: number?, end_time: number?, limit: number?

• get_positionsread-only

  Open-positions leaderboard: largest open positions by notional, optionally filtered by account, broker, or symbol. Drives the Leaderboard (positions) tab.

  account_id: string?, broker_id: string?, symbol: string?, offset: number?, limit: number?, order_by: string?

• get_recent_liquidationsread-only

  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…

  symbol: string, limit: number?

• get_site_overviewread-only

  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…

• get_stake_usersread-only

  Weekly average active stakers. Drives the Stake Users widget.

• get_stake_vs_supplyread-only

  Weekly ORDER staked vs circulating supply and staking ratio. Drives the Stake vs Supply widget.

• get_staking_dailyread-only

  Daily $ORDER staking metrics: staked/unstaked/net amounts, cumulative staker addresses, buybacks, and burned ORDER. Drives the Staking Daily widget.

• get_symbol_inforead-only

  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.

  symbol: string

• get_top_tradersread-only

  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.

  symbol: string?, sort_by: string?, min_notional: number?, limit: number?, cursor: string?

• get_tvl_by_chainread-only

  Total Value Locked broken down by chain, plus a total row. Drives the TVL By Chain widget. Returns newest snapshot rows.

• get_tvl_by_tokenread-only

  TVL and token balance held per collateral token over a trailing window. Drives the TVL By Token widget.

  days: number?

• get_volume_segmentsread-only

  Weekly trading volume split by market-maker vs retail segment. Drives the Volume Segments widget.

• get_weekly_symbol_volumeread-only

  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.

• get_whale_contextread-only

  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.

  address: string, broker_id: string?, account_id: string?, recent_trades_limit: number?

• get_widget_urlread-only

  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.

  widget_id: string, symbol: string?

• open_address

  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…

  address: string

• open_market

  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…

  symbol: string

• resolve_addressread-only

  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…

  address: string

• share_widget

  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…

  widget_id: string