Reference guide
Connect generated model catalogs with authored usage guides and current runtime caveats.
Use authored guides to understand behavior and complete examples, then use the generated catalogs to locate model parameters. A catalog description or SQL snippet is not proof that a particular workflow is implemented end to end.
Guide to catalog map
| Topic | Usage guide | Parameter reference |
|---|---|---|
| Registered averages | Indicator-driven entry | SMA, EMA |
| Current price and local time | SQX indicators | Price, Time |
| Configured order primitive | SQX actions | Order |
| Stop-style primitives | Execution primitives | Stop loss, Trailing stop loss |
| Position calculations | Positions | PnL ticks, Position size |
| Broader model discovery | Indicators & Algorithms | Indicators, Primitives |
From a catalog entry, return here or to the linked usage guide before copying an example into a strategy.
Known catalog limitations
Catalog pages are generated from model metadata and remain unchanged by this documentation expansion. Some metadata examples are older than current validated usage. In particular:
- Order primitive properties are
sizeandlimitPrice; older SQL examples usingquantity,price, orcapitaldo not establish equivalent writable properties. - Current SQX text requires complete rules on one physical line, and does not implement nested groups or reliable OR semantics.
stopLosshas a constructor transmission default that differs from its generated metadata. Configure it explicitly; its distance is a raw price difference in the current implementation.- The registered
riskCapprimitive currently has no implemented enforcement in its callbacks. Its catalog description must not be treated as an active risk limit. - Names containing “ticks,” “period,” or “size” do not establish universal units or data completeness. Read the calculation and execution guides for the specific model.
Choose a complete example
Use practical tutorials, SQX examples, Pine getting started, or policy getting started. Their checks explain expected behavior and limitations.
For shared terminology and environment differences, read the glossary and capability matrix.