API Status and Compatibility

This page defines the support boundary for the public Developer Center. The established HyperionX 1.1.10 HyperionX.Custom contract is the release-safe path. Features found only in the active release-candidate source are marked Preview and must be verified in the packaged build before public release.

Label	Meaning
Current	Implemented, runtime-discovered, and documented for customer use in the packaged release.
Preview	Implemented, but packaging, behavior, or the public contract can still change.
Internal	Used by HyperionX itself and not a supported extension dependency.
Unreleased	Present in the current development working tree but not established as a packaged 1.1.10 contract.
Roadmap	Planned or proposed; do not code against it.

Current Code Lab surface

• HyperionX.Custom.Indicators.Indicator with OnStateChanged() and OnBarUpdate().
• HyperionX.Custom.Strategies.Strategy with managed orders, direct submission, and order/execution callbacks.
• Common ScriptBase series, plots, drawings, multi-series support, and the documented Ctx facade.
• HyperionX.Custom.Addons.AddonBase with the narrow load/unload contract.
• Generated indicator convenience helpers for direct Indicator subclasses in HyperionX.Custom.Indicators.
• Optional indicator IIndicatorAnalysisProvider and IResearchFeatureProvider capabilities.

The runtime activation build—not a Code Lab-only green build—is the final compatibility gate.

Preview surface

• Custom bar types and bar-builder metadata.
• Optimizers and optimization fitness modules.
• Money-management and commission modules.
• Ctx.Alerts, which currently targets HyperionX Discord signals rather than a provider-neutral alert contract.
• Historical position adoption through HistoricalPositionSyncMode in the active release-candidate source.

Code Lab templates and runtime discovery exist for these categories, but a source checkout and an installed package can differ in seeded convenience bases or default modules. Test the actual packaged application used by recipients.

Preview and unreleased: HyperionX.SDK runtime adapter

The active development working tree now contains an in-memory host generator and runtime adapters for direct, concrete subclasses of:

• HyperionX.SDK.IndicatorBase.
• HyperionX.SDK.StrategyBase.

The adapter maps OnInitialize, OnBar(int), OnTick(Tick), and OnDispose into native hosts, proxies [Parameter] properties into the standard property UI, and supplies SDK context adapters for series, selected indicators, plotting, orders, position, risk, and logging.

Not the release-safe 1.1.10 authoring model yet

These adapter files are part of the unreleased candidate source. Until they are included in, tested against, and versioned with the public installer, an SDK-shaped script can behave differently or fail to appear in an existing 1.1.10 installation. Public examples and distributable extensions should continue to use HyperionX.Custom.

The generator recognizes a non-abstract, non-generic class that directly declares SDK IndicatorBase or StrategyBase through the SDK namespace or import. It emits a hidden native host with the suffix HyperionXHost. Treat the generated host name and implementation as internal.

Internal platform objects

A public property can expose an object that contains internal platform members. Reachability through reflection or IntelliSense does not make every member a supported contract.

Examples include:

• Undocumented members reachable through AddonContext.Session.
• Concrete chart controls, windows, and view models behind the chart facades.
• Provider clients and broker-specific implementation classes.
• Build controllers, source generators, and assembly-loader internals.
• Generated SDK host classes and generated indicator-cache implementation details.

Use Ctx, AddonContext.Dispatcher, the documented Code Lab contracts, or the local desktop API instead.

Compatibility rules

• Record the exact packaged HyperionX version used for verification.
• Rebuild and rerun the extension verification matrix after a platform update.
• Treat Preview APIs as potentially source-breaking.
• Do not depend on an unreleased candidate feature in a release sample.
• Avoid hard-coded installation paths and assembly versions.
• Do not ship copied HyperionX binaries in a source bundle.
• Compile distributed samples in a clean installed environment, then complete desktop runtime activation.
• Document required provider capabilities, especially depth, tick, account, and live-order access.
• Check release notes for lifecycle, orders, rendering, research, and packaging changes.

Documentation rule

If a member is not in this Developer Center or its linked references, verify it in the exact target build before use. Do not infer an API from NinjaTrader, another platform, generated source, or a similarly named internal class.

For the consolidated boundary, see Platform API Contract. A proposal or roadmap item is not evidence that a feature is available.