Skip to main content

Getting Started

This guide walks through the standard HyperionX desktop workflow: launch the platform, connect to data, open a chart, add indicators, use Chart Trader, open Code Lab, and save the workspace.

1. Launch HyperionX​

When HyperionX starts, it loads:

  • Application settings.
  • Theme resources.
  • Saved connections.
  • Custom scripts.
  • Saved workspaces.
  • Main window state.
  • Chart and tool windows from the last workspace.

If a workspace contains charts, the app should restore those windows after the shell is ready. A chart may show a loading state while historical candles are requested.

2. Choose A Theme​

Most trading workflows use dark mode. The dark theme is designed for long sessions and should keep dialogs, dropdowns, popups, scroll bars, and child windows on the same dark surface system.

Theme expectations:

  • Primary actions use HyperionX blue.
  • Sell/close/destructive actions use red when appropriate.
  • Dense lists and property grids use gray hover/selection states.
  • Dark dialogs should not show white title bars or white hover buttons.

3. Configure A Connection​

Open Connections from the main window.

Typical settings include:

  • Provider.
  • Connection name.
  • Account mode, such as live, testnet, paper, playback, or simulation.
  • API key or credentials where required.
  • Auto-connect.
  • Provider-specific options.

Credential fields should remain private local settings. They should not appear in chart AI context, support logs, or public local API snapshots.

4. Open A Chart​

Create a chart from the main window and select:

  • Instrument.
  • Data series type.
  • Data series value.
  • Provider or account context.
  • Historical range where available.

A chart is more than a candle display. It can hold indicators, drawings, chart trader state, order lines, positions, AI context, and multi-chart layout state.

5. Add Indicators​

Open the indicator window from the chart toolbar.

Indicators can be:

  • Built-in HyperionX indicators.
  • Custom indicators compiled through Code Lab.
  • Advanced indicators with overlay renderers or their own chart panels.

Indicator panels should be independently resizable. If an indicator throws a runtime error, HyperionX should disable that indicator and log the failure instead of freezing the chart.

6. Use Chart Trader​

Chart Trader provides manual order entry from the chart.

Key controls:

  • Buy/Sell market, ask, bid, limit, and stop actions.
  • Account selector.
  • Instrument display.
  • Order size input.
  • USD/quantity size toggle.
  • Quick size buttons.
  • Leverage selector where supported.
  • Time in force.
  • OCO/bracket strategy selector.
  • Available balance, estimated fee, and required margin.

For crypto symbols, USD order sizing is often easier to understand. Example: entering $100 means HyperionX converts that notional value into the correct instrument quantity using current price and multiplier.

7. Create OCO Brackets​

OCO presets define exits for a filled entry order.

The main order size belongs to Chart Trader. The OCO preset should define:

  • Take-profit distance.
  • Stop-loss distance.
  • Ticks or USD/quote-price distance.
  • Target size percentage.
  • Stop behavior.
  • Time in force.

Single-target brackets should protect and exit the full filled quantity. Multi-target brackets split the filled quantity by percentage.

8. Use Code Lab​

Open Code Lab to create or edit:

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

Always write HyperionX scripts using HyperionX namespaces and APIs. Scripts from other platforms must be ported before they can compile correctly.

9. Use AI Assistance​

Click the chart AI avatar to open the AI chat.

The chart AI can inspect safe read-only context:

  • Symbol and timeframe.
  • Recent candles.
  • Visible candles.
  • Loaded indicators.
  • Loaded strategies.
  • Chart Trader state.

The current AI surface is read-only by default. It should not expose credentials, private keys, filesystem access, or live order submission.

10. Save The Workspace​

Save your workspace after arranging charts and tools.

The workspace should remember:

  • Open charts.
  • Instruments and timeframes.
  • Indicators and panels.
  • Multi-chart layouts.
  • Chart Trader visibility.
  • AI avatar/chat state.
  • DOM and tool windows.
  • Window positions and sizes.

If a restored workspace does not match what was saved, check the workspace restore sequence and logs. Chart data, indicators, overlays, and tool windows should restore only after the required runtime objects are ready.

First-Time Checklist​

Use this checklist before live trading:

  1. Confirm the connection is connected.
  2. Confirm the correct account is selected.
  3. Confirm the correct instrument is selected.
  4. Confirm order size mode is USD or quantity as intended.
  5. Confirm leverage and time in force.
  6. Confirm OCO parameters.
  7. Test order behavior in simulation.
  8. Confirm brackets appear and cancel correctly.
  9. Confirm logs show no provider errors.
  10. Save the workspace.