Request Model Positions

POST

/fa/model/positions

POST

/fa/model/positions

$ curl -X POST https://api.ibkr.com/fa/model/positions \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "cash": [
3     {
4       "actual": 0,
5       "ccy": "USD",
6       "exchangeRate": 1,
7       "instrumentImbalance": 0,
8       "mv": 0,
9       "target": 0.096
10     }
11   ],
12   "mismatched": false,
13   "model": "MCPAPI01",
14   "nlv": 0,
15   "positionList": [
16     {
17       "actual": 0,
18       "actualRangeMax": 1.1,
19       "actualRangeMin": 1.1,
20       "ccy": "USD",
21       "conid": 268084,
22       "dlv": 0,
23       "exchangeRate": 1,
24       "flags": 0,
25       "instrumentImbalance": 0,
26       "instrument": "CSCO",
27       "mismatchType": 0,
28       "mv": 0,
29       "position": 0,
30       "target": 0.432
31     },
32     {
33       "actual": 0,
34       "actualRangeMax": 1.1,
35       "actualRangeMin": 1.1,
36       "ccy": "USD",
37       "conid": 270639,
38       "dlv": 0,
39       "exchangeRate": 1,
40       "flags": 0,
41       "instrumentImbalance": 0,
42       "instrument": "INTC",
43       "mismatchType": 0,
44       "mv": 0,
45       "position": 0,
46       "target": 0.4721
47     }
48   ],
49   "positionTs": 1769614805464,
50   "reqID": 540607,
51   "stkOnly": true,
52   "subscriptionStatus": 1,
53   "totalDlv": 0,
54   "totalMv": 0
55 }

Request all positions held within the model.

Request

This endpoint expects an object.

reqIDlongOptional

Request identifier to uniquely track a request.

modelstringOptional

Name of your model.

sortFieldenumOptional

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.

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.

sortDirectionenumOptional

Direction to sort the request by.

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

Direction to sort the request by. * `ASC` - Sort from greatest to smallest. * `DESC` - Sort from smallest to greatest.

Allowed values:

limitlongOptional

Maximum number of positions to return.

Response

Successfully retrieve position details

cashlist of objects

An object representing each currency held in the model.

mismatchedboolean

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

modelstring

Name of the model.

nlvdouble

Market value of the model.

positionListlist of objects

List of object containing each equity in the model.

positionTslong

Epoch timestamp when the position was retrieved.

reqIDlong

Request identifier to uniquely track a request.

stkOnlyboolean

Describes if the model contains only stocks.

subscriptionStatuslong

Describes if the model is in polling mode.

totalDlvdouble

Diplayed total liquidation value of the model.

totalMvdouble

Market value of the entire position.

Errors

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error