event_field value ref

Value ref

event_field

Field from latest event payload.

Authoring flow:

Call list_event_types().
Pick event_type_id from a returned event type.
Pick event_field from payload_schema.fields.

Example: {"kind": "event_field", "event_type_id": "macro.cpi", "event_field": "value"}

To compare a release against a previous one, set occurrences_back on a second ref and subtract: {"kind": "binary_expr", "op": "-", "left": {"kind": "event_field", "event_type_id": "macro.cpi", "event_field": "value"}, "right": {"kind": "event_field", "event_type_id": "macro.cpi", "event_field": "value", "occurrences_back": 1}}

Backing types

EventFieldValueRef

Required fields

FieldTypeDescription

event_fieldreqstringPayload field from payload_schema.fields. A field the event type's schema does not declare is refused, naming the declared fields.

event_type_idreqstringEvent type ID from list_event_types().

Optional fields

FieldTypeDescription

fillenum: none, previous'previous' carries forward; 'none' resolves only on the event bar.

kindstring-

max_age_secondsanyOf (2 variants)Staleness limit for carried-forward values, in seconds.

occurrences_backinteger0 = latest release; 1 = the release before it, and so on. Counted by distinct data period, so a later revision of an earlier period does not consume a step. Requires an event type whose payload declares a 'period' (the macro.*/treasury.*/market.*/energy.* release families) and fill='previous'. Resolves as missing when fewer than occurrences_back+1 releases are known.

resolutionanyOf (2 variants)Optional higher-timeframe override for this value ref. Set it inside left/right refs such as {'kind': 'indicator', ..., 'resolution': '4h'} or {'kind': 'price', 'field': 'close', 'resolution': '4h'}. Do not put timeframe/source_timeframe on the parent condition. None = strategy timeframe.

symbolanyOf (2 variants)Optional reference symbol this value ref reads from (e.g. 'SPY'). None = the traded/primary symbol. Mutually exclusive with resolution.

Backing types

The IR ValueRef classes this builder field resolves to.

EventFieldValueRef