Platform APIs
HyperionX has several extension and automation layers. Choose the narrowest supported layer for the task and check its release status before distributing code.
API Family Status
| API family | Status | Use it for |
|---|---|---|
| Code Lab Runtime API | Current and Preview by extension type | In-process C# indicators, strategies, add-ons, bar types, optimizers, fitnesses, commissions, and money-management modules. |
| Chart AI Context | Current, in-app | Read-only context for the active-chart assistant. |
| Agent Builder profiles | Preview, gated | Specialized in-app Rion roles and selected context/tool filtering. |
| Local Desktop HTTP API | Preview | Provisioned localhost automation for active-chart context, desktop tools, research, Code Lab compile control, and capability-discovered trading actions. |
| Permissioned simulation actions | Preview, simulation-first | Hyperion Sim place/cancel/modify/close/flatten actions behind settings and entitlements. |
| Provider adapter layer | Internal | HyperionX broker, exchange, simulation, and playback implementations. Not a public provider plugin SDK. |
| Managed Rion cloud desktop bridge | Internal | HyperionX-managed cloud-to-desktop orchestration. Not a third-party integration API. |
| Marketplace | Internal/Unavailable | No supported publishing, installation, signal-following, or live-routing contract in this release. |
| CLI | Unavailable/Roadmap | No supported hx executable ships with the current API. |
| Local live-trading actions | Release-gated Preview; unavailable in the 1.1.10 baseline | Newer enabled builds can expose guarded Hyperliquid and KuCoin actions behind provider-specific capabilities and settings, live_trade, active account/instrument matching, connection state, and exchange permissions. |
For status definitions and the supported Code Lab boundary, see API Status and Compatibility.
Build A Code Lab Extension
Use Code Lab when code should run inside the HyperionX script runtime.
The compiler references these platform assemblies:
HyperionX.Core.dllHyperionX.Chart.dllHyperionX.Model.dllHyperionX.DB.dllHyperionX.SDK.dll
A referenced assembly is not automatically a supported lifecycle. The established HyperionX 1.1.10 package contract does not register HyperionX.SDK.IndicatorBase and HyperionX.SDK.StrategyBase with desktop script discovery. The unreleased candidate source adds a Preview adapter, but release-compatible customer scripts should continue to use the documented generated bases under HyperionX.Custom until that adapter ships with a stable contract.
Choose the extension type in the Extension Type Catalog, then use its guide and reference:
- Indicator Development
- Strategy Development
- Add-on Development
- Code Lab API Reference
- Share and Deploy
Never take a dependency on a concrete desktop window, view model, provider client, database implementation, or another internal object merely because it is reachable through reflection or IntelliSense.
Read Active-Chart Context
The Current in-app Chart AI Context can supply candles, indicator and strategy summaries, Chart Trader state, and selected research-tool state to the chart assistant.
This is an in-app contract, not a general assembly SDK. For the data fields and profile filtering boundary, see Agent Builder API. For provider destinations and local retention, see AI Data and Privacy.
Automate The Desktop Locally
The Local Desktop API is a Preview, token-authenticated HTTP interface bound to 127.0.0.1. It tries ports 5217 through 5226.
Use it only when the integration has a supported way to receive or preconfigure the desktop token. The current app has no public UI or unauthenticated bootstrap route that reveals its generated process token.
Implemented route groups include:
- authenticated health, capability, and tool-schema reads
- active chart, candles, indicators, signals, drawings, news, and trading-state reads
- script inventory and compile-state reads
- Validator, Optimizer, and Research Lab state/actions
- Rion chat and general action classification
- drawing actions
- Hyperion Sim trading actions
- release-gated Hyperliquid and KuCoin live-trading actions in an enabled build
The shared routes, actions, permission gates, and limitations are documented on Local Desktop API. The release-gated live workflow is documented on Local Agent Live Trading API. Do not infer availability from a proposed CLI example, an entitlement name, or an internal service method.
Use Agent Builder Profiles
Agent Builder is a gated Preview UI for specialized Rion profiles. It can filter selected context and recognized in-app actions for non-baseline profiles.
It is not a token-management UI, a hard trading-risk engine, or an HTTP authorization provider. Numeric loss/position/trade fields and account/instrument allowlist text are currently advisory. Agent Builder profiles do not scope the global Local Desktop API.
Understand The Provider Boundary
HyperionX providers normalize external data and trading systems into platform instruments, candles, accounts, orders, positions, and executions. Existing adapters are HyperionX implementation code.
There is no supported public provider SDK, packaging contract, discovery contract, or compatibility promise for third-party provider assemblies in this release. Use documented Code Lab extensions or the provisioned Preview Local Desktop API instead of implementing an internal provider interface.
Do Not Use Internal Cloud Or Marketplace Contracts
The managed Rion desktop bridge can support HyperionX Cloud workflows, but its transport and commands are Internal. Third parties must not call or emulate it.
Marketplace authorization, relay, package, publisher, follower, and runtime-command models are also Internal/Unavailable. See Marketplace Status before distributing anything described as a Marketplace package.
Compatibility Checklist
Before publishing an extension or integration:
- Record the HyperionX version used for verification.
- Confirm that every API family and extension type is Current or an explicitly accepted Preview dependency.
- Compile against a clean installed environment rather than a developer source tree.
- Avoid concrete UI, provider, database, and build-controller objects.
- Check the Local Desktop API capabilities response at runtime instead of assuming a permission.
- Begin and regression-test every HTTP trading integration on Hyperion Sim; enable Hyperliquid or KuCoin only after the installed build and selected account/instrument pass the provider-specific checks.
- Re-run compile and behavioral tests after a platform update.
- Document required provider capabilities and known Preview limitations.
For the consolidated boundary, see Platform API Contract. A roadmap or internal type is not evidence that an API is supported for customer use.