Skip to main content

User Manual

This manual explains how to use HyperionX as a trading platform. It is for users who want to open the app, connect to data, build a workspace, trade manually, run research tools, use Rion AI, and recover when something goes wrong.

For lesson-based training, use the HyperionX Course. For script development, use Code Lab. For API contracts, use Platform APIs.

1. First Launch

When HyperionX opens, it loads application settings, theme resources, saved connections, compiled custom scripts, saved workspaces, and any windows that belong to the active workspace.

Startup can take longer when:

  • A saved workspace contains several charts.
  • Historical data must be downloaded.
  • Custom scripts need to be rebuilt.
  • Provider connections are set to auto-connect.
  • Validator, Optimizer, Agent Builder, DOM, or chart windows are restored.

If the app opens with a blank chart, wait for historical data to finish loading and then check the log window for provider or data errors.

2. Main Window

The main window is the control center for the platform.

Use it to open:

  • Charts.
  • Connections.
  • Options.
  • Code Lab.
  • Validator.
  • Optimizer.
  • Performance windows.
  • Level 2, Time and Sales, SuperDOM, and Mega DOM tools.
  • Workspaces.
  • Rion AI and Agent Builder.
  • Logs and support tools.

The main window should stay compact enough to fit normal desktop screens. If your saved workspace restores the window too tall or off-screen, resize it and save the workspace again.

3. Theme

HyperionX supports dark and light themes. Dark mode is the primary trading theme and should keep child windows, dialogs, dropdowns, popups, scrollbars, charts, property grids, and error windows readable on dark surfaces.

Dark mode expectations:

  • Text should be white or light gray on dark backgrounds.
  • Selection should use neutral gray unless a product action needs brand blue.
  • Buttons should not show bright blue focus outlines by default.
  • Check marks should remain visible.
  • Context menus should follow the active theme.
  • Error dialogs should be readable and should not freeze the app.

If a window has black text on a black background, white popups, blue hover states, or unreadable selection, treat it as a theme bug.

4. Connections

Connections link HyperionX to exchanges, brokers, data feeds, simulation, playback, and provider-specific tools.

Open Connections from the main window. A connection usually includes:

  • Provider.
  • Connection name.
  • Account or environment mode.
  • Credentials, wallet, or API settings where required.
  • Auto-connect setting.
  • Provider-specific configuration.

Common connection modes:

ModeUse
LiveReal account and real order routing.
Testnet or paperProvider-supported non-live environment.
HyperionX SimLocal simulation account for testing.
PlaybackHistorical replay and training.
Read-onlyData or account context without order routing.

Credential fields should not be exposed to Rion AI, support exports, public logs, or script files.

5. Instruments And Data Series

A chart or research test needs an instrument and a data series.

Instrument settings usually include:

  • Connection.
  • Instrument type.
  • Symbol.
  • Base currency.
  • Quote currency.
  • Tick size or price increment.
  • Lot size or minimum quantity.
  • Multiplier.
  • Market type.

Data series settings usually include:

  • Bar type.
  • Type, such as minute, hour, day, tick, or custom.
  • Value, such as 1 minute, 5 minutes, or 500 ticks.
  • Days to load or date range.
  • End date for historical tests.

Backtest leverage belongs to Validator and Optimizer testing workflows. It should not appear when opening a normal chart data series unless that chart workflow explicitly supports a simulation setup.

6. Charts

Charts are the center of the platform. A chart can contain market data, indicators, strategies, drawings, order lines, position banners, Chart Trader, Rion AI, and saved workspace state.

A standard chart includes:

  • Top toolbar.
  • Instrument and timeframe controls.
  • Indicator and strategy buttons.
  • Drawing toolbar.
  • Price panel.
  • Indicator panels.
  • Price axis.
  • Time axis.
  • Chart Trader panel.
  • Rion avatar and chat panel.

Use the chart toolbar to change timeframe, add indicators, add strategies, open data series settings, open news, open DOM tools, and toggle panels.

7. Timeframes

The timeframe dropdown should offer common intraday and higher-timeframe values, not only a few presets.

Typical choices include:

  • 1 minute.
  • 2 minutes.
  • 3 minutes.
  • 5 minutes.
  • 10 minutes.
  • 15 minutes.
  • 30 minutes.
  • 1 hour.
  • 2 hours.
  • 4 hours.
  • 1 day.

Changing timeframe should reload the chart for the selected instrument and preserve active chart context where possible.

8. Multi-Chart Layouts

Multi-chart mode lets one window show multiple charts.

Expected behavior:

  • Clicking a chart makes it the active chart.
  • Toolbar actions apply to the active chart.
  • Time and Sales, Level 2, and Mega DOM should open for the active chart instrument.
  • Each chart can have its own instrument and timeframe.
  • Drawing tools should draw on the active chart.
  • Chart Trader should resize without hiding important controls.
  • Workspace save/load should restore the layout and selected chart.

If a top toolbar command opens a tool for the wrong instrument, click the intended chart first and verify the active chart highlight.

9. Drawing Tools

The left chart toolbar contains drawing tools.

Common drawing workflows:

  • Select the pointer tool to move or select existing drawings.
  • Select line, ray, horizontal line, vertical line, rectangle, ruler, or text to add a drawing.
  • Click and drag on the chart to place the drawing.
  • Select a drawing to move or resize it when supported.
  • Use remove drawing actions to delete selected drawings or clear drawing groups.

Manual drawings, script-created drawings, and Rion-created drawings should be tracked separately so clearing one group does not delete unrelated drawings.

10. Indicators

Indicators can be built-in or custom scripts compiled through Code Lab.

Add indicators from the chart toolbar. After adding an indicator:

  • Confirm it appears in the indicator list.
  • Confirm parameters are visible and editable.
  • Confirm the correct panel is used.
  • Confirm it renders correctly while scrolling, zooming, and resizing.
  • Confirm it can be removed without freezing the chart.

If an indicator throws an error, HyperionX should disable or isolate the failing indicator and write diagnostics to the log instead of freezing the app.

11. Strategies On Charts

Strategies can be loaded on charts for visual testing, live observation, or controlled automation where supported.

When enabling a strategy:

  • The enabled toggle should clearly show the active state.
  • Strategy metadata should show the actual script metadata, not generic fallback text.
  • Parameters should be editable.
  • Connection and instrument selectors should reflect available connected providers.
  • Strategy errors should appear in readable themed dialogs and logs.

Always test strategy behavior in simulation before using live routing.

12. Chart Trader

Chart Trader is the manual order entry panel attached to a chart.

Core controls:

  • Account selector.
  • Instrument display.
  • Buy and sell buttons.
  • Order type controls.
  • Order quantity.
  • USD or quantity sizing mode where supported.
  • Quick size buttons.
  • Leverage selector where supported.
  • Time in force.
  • OCO or bracket preset selector.
  • Available balance.
  • Estimated fees.
  • Required margin.
  • Position and PnL display.

Order quantity should remain visible even when Chart Trader is resized. Leverage should have its own row when space is tight.

13. Order Size And Leverage

HyperionX supports workflows where the order box can represent quantity or notional value.

SettingMeaning
QtyThe value is direct instrument quantity.
USDThe value is notional order value. HyperionX converts it using price, multiplier, and instrument metadata.
LeverageSimulation or provider leverage multiplier where supported.

For perpetual futures, leverage simulation is important because margin and notional exposure are different. A simulator should model position notional, required margin, fees, realized PnL, unrealized PnL, liquidation risk where supported, and max leverage rules.

14. OCO And Bracket Orders

OCO presets define exits for a filled entry.

An OCO preset can include:

  • Take-profit distance.
  • Stop-loss distance.
  • Tick or price distance mode.
  • Target size percentage.
  • Breakeven behavior.
  • Trailing stop behavior.
  • Time in force.

The main order size belongs to Chart Trader. The OCO preset defines how the exit orders behave after entry.

15. Orders, Positions, And Banners

Active orders and positions should be visible on the chart.

Expected chart behavior:

  • Entry orders show readable banners.
  • Stop orders use danger styling.
  • Profit targets use profit styling.
  • Position banners show side, quantity, entry, PnL, and close action.
  • Switching timeframe on the same instrument should not remove valid position and entry lines.
  • Drag-to-modify should work for supported working orders.

If the chart and orders grid disagree, use the provider log and account/order windows as the source for diagnostics.

16. Level 2, Time And Sales, SuperDOM, And Mega DOM

Market depth tools should open for the active chart instrument when launched from a chart toolbar.

Use these windows for:

  • Level 2 order book.
  • Bid/ask depth.
  • Time and Sales prints.
  • DOM order entry where supported.
  • Spread and liquidity inspection.

Window titles should include the instrument when possible so multiple tools are easy to identify.

Spread should be calculated from the best ask minus best bid and displayed consistently across Level 2, Mega DOM, and related windows.

17. News

HyperionX has a shared economic news pipeline used by:

  • News window.
  • NewsEcon indicator.
  • Rion news context.

Open the News window from the chart toolbar when available. Use filters for:

  • Time range.
  • Currency.
  • Impact.
  • Search text.

The NewsEcon indicator can show upcoming events on a chart and can be used by bots or agents as context. News is context only; it is not a trade signal by itself.

18. Workspaces

Workspaces save your layout and restore it later.

A workspace should save:

  • Main window size and position.
  • Chart windows.
  • Multi-chart layouts.
  • Instruments and timeframes.
  • Indicators and parameters.
  • Strategy state where supported.
  • Chart Trader visibility and width.
  • Drawing objects where supported.
  • DOM and tool windows.
  • Validator and Optimizer windows.
  • Agent Builder window.
  • Window locations and sizes.

Save the workspace after arranging charts and tools. If a restored workspace misses windows or restores sizes incorrectly, save a new workspace after fixing the layout and check logs for restore errors.

19. Code Lab

Code Lab is the script editor for HyperionX custom code.

Use it to create:

  • Indicators.
  • Strategies.
  • Bar types.
  • Optimizers.
  • Optimization fitness modules.
  • Commissions.
  • Money management modules.
  • Addons.

Code Lab scripts must use HyperionX APIs, namespaces, lifecycle methods, and drawing/rendering methods. Scripts copied from another platform must be ported before they can compile.

A script is ready when:

  • It compiles in Code Lab.
  • It appears in the correct indicator or strategy list.
  • It handles short histories without exceptions.
  • It behaves correctly in dark and light themes if it renders UI.
  • It can be explained using HyperionX APIs.

20. Validator

Validator tests one strategy across one or more instruments.

Use Validator to answer:

  • Does the strategy work across multiple instruments?
  • Does it survive different market regimes?
  • Are results dependent on one lucky symbol?
  • Do commissions, spread, and slippage change the result?
  • Does leverage simulation change the risk profile?

Validator result windows should include summary, chart, trades, orders, and portfolio-style views where supported. Chart views should allow drag, zoom, crosshair inspection, and reset/fit controls.

21. Optimizer

Optimizer searches strategy parameter combinations.

Use it for:

  • Testing parameter ranges.
  • Comparing in-sample and out-of-sample periods.
  • Finding stable areas instead of only max net profit.
  • Saving results for later review.
  • Sending selected results to Validator.

Avoid choosing a strategy only because it had the best single optimization result. Favor stable parameter zones, enough trades, controlled drawdown, and out-of-sample performance.

22. Performance And Results Database

Performance windows and saved result databases help review tests after they finish.

Use them to inspect:

  • Net profit.
  • Drawdown.
  • Profit factor.
  • Sharpe and Sortino where available.
  • Total trades.
  • Win percentage.
  • Average trade.
  • Equity curve.
  • Trades and order details.

If a result looks wrong, verify order size, multiplier, tick size, commission model, spread model, leverage, and historical data quality.

23. Historical Data Import

Historical data import is used to bring local tick or bar files into HyperionX storage.

Import workflow:

  1. Select the historical data source folder or files.
  2. Select provider/category/market/symbol settings.
  3. Confirm whether existing data should be overwritten.
  4. Start import.
  5. Watch progress and logs.
  6. Convert tick data to minute or day data if selected.
  7. Verify the saved data appears under the expected symbol and date path.

Long imports should show progress and should not block unrelated app workflows unless the import operation requires exclusive access to the same files.

24. Rion AI

Rion AI can help with chart context, scripting, research, and platform operations.

Rion can inspect safe context such as:

  • Active symbol.
  • Timeframe.
  • Visible candles.
  • Loaded indicators.
  • Loaded strategies.
  • Chart Trader state.
  • News context.
  • Validator and Optimizer state where permissioned.

Trading actions must be permissioned. By default, user confirmation should be required before Rion places or modifies orders. If auto-execute is enabled in settings, it should be off by default and clearly scoped by account, instrument, max size, leverage, and action type.

25. Agent Builder

Agent Builder creates specialized Rion agents.

Use it to configure:

  • Agent name and role.
  • System instructions.
  • Prompt files.
  • Workspace access.
  • Tool permissions.
  • Memory settings.
  • Model/provider routing where supported.
  • Trading permissions and risk limits.
  • Audit behavior.

Agent Builder is different from normal chat. Chat is a conversation surface; Agent Builder defines how a specialized agent behaves and what tools it is allowed to use.

26. Options

Options control application-wide settings.

Common areas:

  • Project.
  • Preferences.
  • Display.
  • Email.
  • API.
  • Historical Data.
  • Calculation.
  • Optimizer settings.

Options windows should follow the active theme. API URL fields should not include hard-coded production values unless the setting is intentionally preconfigured by a release profile.

27. Logs And Diagnostics

Use logs to diagnose:

  • Provider connection errors.
  • Historical data loading.
  • Code Lab compile errors.
  • Indicator and strategy runtime exceptions.
  • Workspace restore issues.
  • Validator and Optimizer runs.
  • Rion API calls and actions.

When reporting a problem, include:

  • What window was open.
  • What instrument and timeframe were selected.
  • What connection was active.
  • What action caused the issue.
  • The exact log error and timestamp.
  • Whether the app froze or recovered.

28. Error Recovery

Errors should be readable and non-blocking where possible.

If a chart freezes:

  1. Wait a few seconds for any import, data load, or script operation to finish.
  2. Check the log window.
  3. Remove the last added indicator or strategy if the UI allows it.
  4. Reopen the chart from the workspace if needed.
  5. Disable the failing script in Code Lab and rebuild.
  6. Save a clean workspace after recovery.

If the whole app freezes repeatedly after loading a workspace, start with a clean workspace or remove the failing custom script from the custom scripts folder before relaunching.

29. Live Trading Checklist

Before live trading:

  1. Confirm the provider is connected.
  2. Confirm the account is correct.
  3. Confirm the instrument is correct.
  4. Confirm live, testnet, paper, or simulation mode.
  5. Confirm order size mode.
  6. Confirm leverage.
  7. Confirm time in force.
  8. Confirm OCO or bracket settings.
  9. Confirm order confirmation settings.
  10. Confirm max order size and risk limits.
  11. Confirm the chart, orders grid, positions grid, and account state agree.
  12. Test the same flow in simulation first.

Use these pages when you need more detail: