Sign in
latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingFaAllocationManagement

Request Model Positions

Request all positions held within the model.

post/fa/model/positions

Request body

reqIDinteger

Request identifier to uniquely track a request.

modelstring

Name of your model.

sortField'actual' | 'actualRangeMax' | 'actualRangeMin' | 'ccy' | 'conid' | 'dlv' | 'instrumentImbalance' | 'instrument' | 'mismatchType' | 'mv' | 'position' | 'target'

Field to sort the response by.

  • actual - Current actual model allocation for the instrument.
  • actualRangeMax - Maximum actual model allocation allowed for the instrument.
  • actualRangeMin - Minimum actual model allocation allowed for the instrument.
  • ccy - Currency of the instrument.
  • conid - Contract identifier, or conid.
  • dlv - Market value.
  • instrumentImbalance - How far an instrument's actual allocation is from its model.
  • instrument - Symbol of the security.
  • mv - Market value of the model position.
  • position - Number of shares held by the model.
  • target - Target percentage of an instrument held within a model.
sortDirection'ASC' | 'DESC'

Direction to sort the request by.

  • ASC - Sort from greatest to smallest.
  • DESC - Sort from smallest to greatest.
limitinteger

Maximum number of positions to return.

Response

Successfully retrieve position details

mismatchedboolean

Notes if the Actual allocation has become misalligned with the Target.

modelstring

Name of the model.

nlvnumber double

Market value of the model.

positionTsinteger

Epoch timestamp when the position was retrieved.

reqIDinteger

Request identifier to uniquely track a request.

stkOnlyboolean

Describes if the model contains only stocks.

subscriptionStatusinteger

Describes if the model is in polling mode.

totalDlvnumber double

Diplayed total liquidation value of the model.

totalMvnumber double

Market value of the entire position.