Skip to main content

UIBuilderReference

Complete UI Builder reference metadata. Call the uiBuilderReference query to get this before constructing UIBuilderConfigInput. All data is derived from the backend implementation and is always in sync with the API.

type UIBuilderReference {
  indicators: [IndicatorSpec!]!
  categories: [UIBuilderCategorySpec!]!
  conditionNodeTypes: [ConditionNodeSpec!]!
  operandTypes: [OperandTypeSpec!]!
  rewardNodeTypes: [RewardNodeSpec!]!
  rewardOperandTypes: [RewardOperandSpec!]!
  exampleConfig: String!
}

Fields​

UIBuilderReference.indicators ● [IndicatorSpec!]! non-null object​

Catalog of all supported indicator types with their parameter schemas and output columns. Use this to construct IndicatorDefinitionInput objects.

UIBuilderReference.categories ● [UIBuilderCategorySpec!]! non-null object​

Indicator grouping categories (trend, momentum, volatility, volume, custom) with labels and descriptions. Use this to build category tabs/filters in the UI.

UIBuilderReference.conditionNodeTypes ● [ConditionNodeSpec!]! non-null object​

Condition node type specifications. Use this to understand the JSON structure of entryConditions and exitConditions.

UIBuilderReference.operandTypes ● [OperandTypeSpec!]! non-null object​

Operand type specifications. Use this to understand what can be used as left/right operands in COMPARE/CROSSOVER nodes.

UIBuilderReference.rewardNodeTypes ● [RewardNodeSpec!]! non-null object​

Reward-expression node type specifications (RL Release 2). The palette source for the RL RewardExpressionEditor — the closed whitelist of reward node types.

UIBuilderReference.rewardOperandTypes ● [RewardOperandSpec!]! non-null object​

Reward operand (leaf) type specifications (RL Release 2). The closed whitelist of reward operands (pnl, action, position, trade_duration, is_valid, param, const).

UIBuilderReference.exampleConfig ● String! non-null scalar​

A minimal working example of a UIBuilderConfigInput (RSI oversold/overbought strategy). Paste and modify this as a starting point.

Returned By​

uiBuilderReference query