bayesline.api.equity.TieoutReferenceRef

bayesline.api.equity.TieoutReferenceRef#

model TieoutReferenceRef#

Reference to an uploaded reference time-series for one hierarchy leaf.

Fields#

Field

Type

Required

Default

kind

Literal[‘returns’, ‘levels’]

Yes

series

str

Yes

source

str

Yes

field kind: Literal['returns', 'levels'] [Required]#

How the series values should be interpreted. ‘returns’ are simple period returns; ‘levels’ are cumulative levels (e.g. NAV or index level).

field series: str [Required]#

Name of the series/column within the uploaded dataset.

field source: str [Required]#

Name of the uploaded time-series factors dataset that holds the reference series.