Omni Terminal Docs
Documentation for Hyperliquid trading, risk, and market investigation.
Use these docs to set up an agent, integrate x402 or MCP, understand Omni Terminal’s trading workflow, and trace market data, AI news, wallet, and risk behavior.
Plain-text route maps are available at /llms.txt and /llms-full.txt for tools that prefer a compact index.
At a glance
- 20+ public pages
- Agents + traders Agent setup, SDK, x402, MCP, AI News, IBKR, price, L4, liquidations, funding, clusters, Ask Omni, mobile, and API architecture.
- Cross-repo evidence
- 4 repos Omni Terminal plus sibling docs for data-api, node/orderbook, and wallet clustering.
- Public-safe outputs
- No secrets Repo-scoped references only, with no host inventory, service tokens, or absolute machine paths.
Agent Flow
Build with Omni market intelligence
- 1 Choose HTTP, MCP, or SDK Match Omni discovery and payment to the tools your agent host already supports.
- 2 Run no-spend verification Build the public SDK and validate live contracts before adding a funded buyer wallet.
- 3 Buy one bounded result Set a per-call cap and validate payment, schema, component status, and freshness.
- 4 Keep execution separate Apply policy locally and use the broker or venue for preview and order authority.
User Flow
Recommended path through Omni Terminal
- 1 Connect and verify access Start with wallet connection, session scope, and funding authority expectations.
- 2 Read the market workspace Use chart, orderbook, liquidation stats, funding, and news context before sizing a trade.
- 3 Plan execution Move from a single order ticket into Custom > Scale when you need laddered levels.
- 4 Check collateral authority Separate stored agent trading authority from wallet-signed funding and collateral movement.
- 5 Share terminal views Use the Telegram screenshot bot and share-renderer for public chart, liquidation, trader, and news views.
Start here
Popular guides and feature pages
For agents
- Agent quickstart
Choose HTTP, MCP, the TypeScript SDK, or a broker-connected research workflow.
- TypeScript SDK
Install the verified release or run source checks, streams, payments, and examples.
- Hyperliquid testnet agents
Run guarded momentum, mean-reversion, or Omni-risk agents against testnet only.
- Vault SDK and MCP
Add public vault discovery, followers, leader trading, agents, and terminal support.
- Private and vault TWAPs
Choose the correct testnet executor and keep account, signer, and builder scope pinned.
- x402 over HTTP
Inspect a 402 challenge, enforce a price cap, pay, and validate the bounded result.
- x402 over MCP
Connect Streamable HTTP, call the free catalog, and approve paid tools explicitly.
- Trading-agent pattern
Keep Omni research separate from Coinbase, Robinhood, or other broker execution.
- x402 product catalog
Thirteen bounded HTTP products, prices, schemas, freshness, and trust boundaries.
- Robinhood and broker agents
Research with Omni while account state, preview, and execution remain at the broker.
Guides
- Trade from chart context without separating execution from risk
A public guide to chart-first Hyperliquid trading in Omni Terminal, including order placement context, review steps, and risk checks.
- Build order ladders with size, price, and account checks visible
A guide to reviewing scaled order ladders in Omni Terminal with public-safe examples, sizing checks, and risk notes.
- Move collateral only when the right wallet authority is connected
A guide to Omni Terminal collateral routing, wallet authority requirements, Manage Collateral, and Hyperliquid funding safety boundaries.
- Connect the right wallet before trading or funding actions
A guide to wallet connection, scoped wallet reconnect states, and session expectations in Omni Terminal.
- Generate chart, trader, and liquidation screenshots from Telegram
A guide to Omni Terminal Telegram bot screenshot workflows, supported commands, routing expectations, and dev/prod safety boundaries.
Features
- AI News Subscription
Paid, tradable market intelligence with event clustering and chart-linked context.
- Hyperliquid Node & Data API
All-user positions, liquidation levels, L4, dedicated nodes, and shared fanout.
- IBKR Private Beta
Invite-only paper stocks, option chains, strategy analysis, and cross-venue views.
- Price & Market Structure
Chart context, ticker, candles, regime, and stream-backed execution visibility.
- L4 Orderbook
Raw depth and order-level interpretation for market structure and liquidity.
- News & AI Analysis
GPT news, vector/event dedupe, symbol routing, and terminal risk context.
- Wallet Clusters & Trader Insights
Cluster outputs, trader-profile workflows, and investigation surfaces.
- Liquidations & Margin Stress
Liquidation stats, FFF curves, buckets, clusters, and portfolio stress context.
- Funding & Basis
Funding history and context for positioning, carry, and dislocation analysis.
- Implied Volatility
IV and volatility surfaces as supporting analytics inside the terminal workflow.
- Ask Omni Risk Engine
GPT-powered portfolio and risk snapshots built from account, market, and news context.
- Hyperliquid Node Operations
Why Omni runs its own node and orderbook stack, and what makes that hard.
- Mobile & iPad Terminal
Phone and tablet trading layout, navigation, touch targets, and parity checks.
- Terminal & API Architecture
The terminal/public API split and the node to data-api to terminal chain.
- Public API Reference
OpenAPI reference for public market data, AI News, read-only ML Market Regimes, Ask Omni, and streams.
- Ask Omni Research Bundles
Compose the daily roundup, news, risk, carry, liquidations, and charts with x402 and MCP.
Indexes
Plain-text docs and sitemap
Use these files when you need a compact route map, a longer plain-text summary, or the crawlable URL list.
- /llms.txt
Compact route map and product summary.
- /llms-full.txt
Longer plain-text overview with guide and source context.
- /sitemap.xml
Crawlable URLs for docs, legal pages, and text indexes.
How to use these docs
Start with the workflow you care about, then follow the implementation references when you need more detail.
- Use the feature pages for fast orientation and page-level positioning.
- Use the guide pages for step-by-step workflows in the terminal.
- Use the references to trace behavior back to an Omni or sibling-repo document.
What is covered in phase one
Phase one covers the core surfaces Omni Terminal is already known for in the product and repo.
- Agent quickstarts, the TypeScript SDK, x402 HTTP, MCP, broker-agent patterns, paid AI News, Hyperliquid data services, IBKR, price, L4, liquidations, funding, IV, wallet clusters, trader profiles, Ask Omni, node operations, and API architecture.
- Each page explains what Omni does, why traders care, what supports the feature, and what the caveats are.
- Every page uses repo-scoped citations only.
References
Implementation references
Plain-text routing notes
omni-terminal/docs/LLMS_AUTHORITY.mdLists source docs used by the plain-text indexes and docs summaries.
Terminal API architecture
omni-terminal/docs/ARCHITECTURE_TERMINAL_API.mdDocuments the terminal/public API split and browser-facing route model.
WebSocket streams
omni-terminal/docs/WS_STREAMS.mdDocuments the stream inventory and which views depend on live WebSocket data.