Portfolio Allocation

POST

/pa/allocation

POST

/pa/allocation

$ curl -X POST https://api.ibkr.com/pa/allocation \
>      -H "Content-Type: application/json" \
>      -d '{
>   "acctIds": [
>     "DU123456"
>   ],
>   "type": "FINANCIAL_INSTRUMENT"
> }'

1 {
2   "id": "getAllocation",
3   "currency": "USD",
4   "realtime": false,
5   "date": "20240611",
6   "allocations": {
7     "SECTOR": {
8       "long": {
9         "total": {
10           "nav": 111598.1,
11           "weight": 1
12         },
13         "items": [
14           {
15             "id": "51",
16             "name": "Basic Materials",
17             "nav": 2593.59,
18             "weight": 0.02324045,
19             "color": "#007aa0"
20           },
21           {
22             "id": "57",
23             "name": "Technology",
24             "nav": 27329.01,
25             "weight": 0.24488781,
26             "color": "#008fd5"
27           }
28         ]
29       },
30       "short": {
31         "total": {
32           "nav": -42904.21,
33           "weight": 1
34         },
35         "items": [
36           {
37             "id": "51",
38             "name": "Basic Materials",
39             "nav": -708.14,
40             "weight": 0.01650514,
41             "color": "#007aa0"
42           }
43         ]
44       }
45     }
46   }
47 }

Returns consolidated portfolio allocation by Financial Instrument, Asset Class, Sector, Region, or Country for a given set of accounts. Result is aggregated for the included accounts. Current day data is supported only if all included accounts have the same base currency as specified in the currency parameter.

Request

This endpoint expects an object.

acctIdslist of stringsRequired

typeenumRequired

The allocation category type. One of FINANCIAL_INSTRUMENT, ASSET_CLASS, SECTOR, REGION, COUNTRY, or ALL. Case insensitive. When ALL is specified, the response includes allocations for every category type.

currencystringOptionalDefaults to USD

Three character currency code. The base currency to use for the NAV calculation in the response.

datestringOptional

Optional. Formatted as yyyymmdd. If specified, should be prior to the current day. If not specified, request will be for the current day. If the request is for current day and current day data is not available, then the response will be for the previous business day.

modelstringOptional

Optional. Model portfolio name to use for the allocation calculation.

Response

Returns the allocation breakdown for the specified accounts.

idstring

Response identifier.

currencystring

Three character currency code. Currency of NAV values, as specified in the request.

realtimeboolean

true indicates the response is for current day data.

datestring

The as-of date for the NAV and allocations. Formatted as yyyymmdd.

allocationsmap from strings to objects

Object keyed by allocation type (FINANCIAL_INSTRUMENT, ASSET_CLASS, SECTOR, REGION, or COUNTRY). When type=ALL is requested, multiple keys may be present.

excludedlist of strings

Requested accounts that were not included in the result due to an error.

warningstring

Warning message, if any.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error