Docs / The model / MarketTwin

MarketTwin.

A digital twin is a model of a market that stays current because the record feeds it.

Figure 1MarketTwinspecified

MarketTwin is a definition at brand scope. The drawing shows its fields and the objects that they point at.

kind: definition
scope: brand
key: the vertical, the template version, the brand and the readings hash, versioned
store: postgres
family: market

Fields#

field	type	required	note
`vertical`	`id`	yes
`segment`	`id`	no
`brand`	`id`	yes
`template`	SystemsModelTemplate	yes
`template_version`	`count`	yes
`family`	ModelFamily	yes
`way`	WayOfGoingToMarket	no	the way of going to market the twin serves
`chain`	`id`	yes	the vertical’s chain the stocks start from
`participants`	`[id]`	yes	the participants placed on the chain for this brand
`readings_hash`	`hash`	yes	the hash of every reading the twin was instanced over, at their versions
`as_of`	`time`	yes	the date the state is read as of
`state`	StockLevel	yes	the level of every stock as of the date
`steps`	`[id]`	yes	the simulations run on this twin, in order
`strategy`	`id`	no	the strategy whose plays are the twin’s interventions
`game`	GameOfRoles	no	the game of roles laid over the twin, where its family or its template carries one
`version`	`count`	yes
`content_hash`	`hash`	yes
`state_of`	Readiness	yes	ready when every stock the template needs has a reading or is marked never measured, and the template is ready

Routes that use it#

/v1/read/market_twin returns it
/v1/act/make_market_twin returns it