Platform API Contract
This page defines which HyperionX code and integration surfaces public developers can depend on. It is a status and compatibility boundary, not a dump of internal desktop classes.
Use the documentation version map to match a feature to the public download, signed release record, or reviewed source. The established authoring model remains HyperionX.Custom; its V2 facade starts in 1.1.12 and later corrections are versioned in the V2 guide. The direct SDK runtime adapter remains Preview; a newer version number does not make it a stable public contract.
Status Definitions
| Status | Contract |
|---|---|
| Current | Shipped in the reviewed release and documented for the stated public use. |
| Preview | Implemented or present in the active development tree, but packaging, compatibility, onboarding, or safety behavior is not yet a stable public contract. |
| Internal | Used by HyperionX itself; third-party code must not depend on it. |
| Unavailable | No supported public workflow exists. |
| Roadmap | Direction only. No callable contract is promised. |
Public Surface Map
| Surface | Status | Public boundary |
|---|---|---|
Generated HyperionX.Custom script runtime | Current | Established Code Lab indicator/strategy model, including the opt-in V2 facade and its documented version requirements. |
| Add-ons and chart render interfaces | Current, narrow | Use only the documented lifecycle/context or render-context members. Desktop windows and view models remain Internal. |
| Custom bar and research extension families | Preview | Product-owned runtime/default work is recorded in signed release 1.1.11 and later. This audit did not independently test the distributed MSI; verify the target build and first-launch discovery. |
HyperionX.SDK.dll as a reference assembly | Current | Code Lab can reference the assembly. Reference availability alone does not guarantee runtime activation. |
HyperionX.SDK runtime host adapter | Preview | Present in the reviewed source and wired into its build/runtime generation path. It is not a stable public 1.1.12 authoring contract. |
| Local Desktop HTTP API | Preview | Loopback-only, token-authenticated, capability-discovered interface. Public token onboarding and schema stability are incomplete. |
| Agent Builder context/profile model | Preview | In-app profile filtering and advisory configuration. It is not a standalone SDK or a per-token API scope. |
| Provider adapters and desktop services | Internal | Do not reference provider, WPF, controller, database, licensing, or build-service implementations. |
| Managed Rion cloud desktop bridge | Internal | Not a third-party integration endpoint. |
| Marketplace packages and follower APIs | Internal / Unavailable | No supported public publishing, package-install, or follower-routing contract. |
hx command-line interface | Unavailable / Roadmap | No supported CLI ships with this release. |
Established Code Lab Contract
The established Code Lab model builds one custom project rooted at:
%USERPROFILE%\Documents\HyperionX\Bin\Custom
| Extension | Namespace | Public base | Status |
|---|---|---|---|
| Indicator | HyperionX.Custom.Indicators | Indicator | Current |
| Strategy | HyperionX.Custom.Strategies | Strategy | Current |
| Add-on | HyperionX.Custom.Addons | AddonBase | Current, narrow |
| Bar type | HyperionX.Custom.BarTypes | Documented bar-type base | Preview |
| Optimizer | HyperionX.Custom.Optimizers | Optimizer | Preview |
| Optimization fitness | HyperionX.Custom.OptimizationFitnesses | OptimizationFitness | Preview |
| Money management | HyperionX.Custom.MoneyManagements | MoneyManagement | Preview |
| Commission | HyperionX.Custom.Commissions | Commission | Preview |
Use the exact installed templates and Extension Type Catalog before choosing a namespace or base. Do not infer a contract from a class found elsewhere in the desktop source.
Lifecycle And Data
The normal indicator/strategy contract is built around:
OnStateChanged()for defaults and runtime configuration;OnBarUpdate()for bar-driven logic;- supported update hooks documented in Lifecycle Reference;
Open,High,Low,Close,Volume,DateTime, andInputseries;CurrentBarand the documented multi-series collections;Series<double>,Plot,AddSeries(...), and supported plot registration;- public drawing, rendering, and managed strategy-order helpers.
Use Code Lab API Reference for a quick member map and the dedicated reference pages for signatures and lifecycle detail.
Parameters And Generated Helpers
Editable script settings use [HyperionXProperty] together with supported .NET metadata such as [Display], range validation, and XML/serialization attributes where documented.
Indicator convenience helpers are generated from compilable public indicator classes and supported parameters. A green editor build is not the final runtime test: runtime activation performs a separate authoritative compile/load pass. See Parameters And Generated Helpers and Build, Test, And Debug.
Orders
Strategies should use the documented managed entry, exit, stop, and target helpers for normal workflows. Direct SubmitOrder(...) use transfers working-order tracking, partial-fill handling, cancel/replace behavior, and OCO coordination to the extension.
No script API removes the need to verify the selected account and provider state. Test with LocalPaper. Playback does not select it automatically; do not rely on a build-specific external-account guard to correct the selection.
Preview SDK Runtime Adapter
The reviewed 1.1.12-versioned source snapshot contains runtime hosts and source generation that adapt HyperionX.SDK indicator and strategy bases into the desktop calculation engine. This changes the earlier reference-only state, but it does not make the adapter a stable public API or prove its presence in the distributed MSI.
Until a release promotes it:
- use the generated
HyperionX.Custommodel for release-compatible customer extensions; - do not advertise a direct SDK-based extension as compatible with the stable 1.1.12 public contract;
- do not depend on adapter-generated class names or internal host implementation details;
- retest discovery, parameters, lifecycle, plots, orders, unload, and rebuild behavior against the signed target package.
Local Desktop API Preview
The local HTTP interface binds to 127.0.0.1, tries ports 5217 through 5226, and requires the desktop token for requests other than CORS preflight. It exposes capability discovery and scoped chart, news, drawing, Code Lab, research, chat, and trading-action routes. An enabled installed build can expose guarded Hyperion Sim, Hyperliquid, and KuCoin actions only when the corresponding release capability and provider-specific gates are present.
The contract is capability-driven: a client must inspect the installed build instead of assuming a route or entitlement. Current limitations include:
- no supported public UI for copying or rotating an app-generated token;
- no public OpenAPI document or generated client;
- no chart identifier for multi-chart targeting;
- no streaming route;
- Hyperliquid and KuCoin live support is release-gated and capability-discovered rather than implied by the route or entitlement alone;
- no stable compatibility guarantee beyond the installed capability response.
Agent Builder profile settings do not scope the global HTTP token. A request confirmation field is supplied by the caller and does not create an independent desktop approval dialog.
Use Local Desktop API for shared routes, authentication, permissions, and audit records. Use Local Agent Live Trading API only when the installed build explicitly enables the release-gated live workflow.
Internal Boundaries
Public extensions and integrations must not depend on:
- WPF windows, controls, view models, or dispatch implementation beyond the documented add-on context;
- concrete provider adapters, credentials, sessions, or native SDK wrappers;
- desktop controllers, build services, licensing services, repositories, database entities, or file formats;
- managed Rion bridge transport or cloud command envelopes;
- Marketplace endpoints, authorization flows, package proofs, follower messages, or storage formats;
- undocumented members exposed through a broad object such as an internal session reference.
An internal type being public in a .NET assembly is not a promise of compatibility.
Compatibility Rules
- Record the exact HyperionX version used to build and test an extension.
- Compile and activate it in a clean installed environment, not only a source checkout.
- Use only members documented as Current or an explicitly accepted Preview dependency.
- Treat a platform upgrade as a compatibility event; rebuild and rerun lifecycle, data, and order tests.
- Keep class names unique across the shared custom project.
- Package source only through the documented reviewable source workflow.
- Do not bundle credentials, customer data, compiled platform assemblies, or internal endpoints.
- Document provider, entitlement, and Preview dependencies for users.