Portfolios

Download Spec

All portfolios related paths.

List portfolios allocations

get /portfolios/allocations

List portfolios allocations

sort

string

Sort the result by id.

Default
"id"
Enum
  • id

order

string

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

Default
"ASC"
Enum
  • ASC

offset

int

int32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min
0

limit

int

int32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

start_date

string

Returns portfolio allocations with dates starting from and including this date (UTC)

Example
"2022-10-14"

end_date

string

Returns portfolio allocations with dates up until this date (UTC)

Example
"2022-10-14"

instrument_ids

string

Filters portfolio allocations containing the instruments ID's

Example
"bf72bdc1-b342-494f-9739-b27ae9011b86,dcbe2cf4-4f37-4fe5-9393-4fb52bb87fab"

Response

ExamplesSchema

Portfolios allocations

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "c27c1fdc-b129-4d7a-95ac-c8a4f05d2804",
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "name": "Allocation 1",
      "allocation": [
        {
          "instrument_id": "IE00B0M62Q58",
          "instrument_id_type": "ISIN",
          "weight": "0.7"
        },
        {
          "instrument_id": "US0378331005",
          "instrument_id_type": "ISIN",
          "weight": "0.3"
        }
      ]
    }
  ]
}

Create portfolios allocation

post /portfolios/allocations

Create portfolios allocation

name

string

Allocation name

allocation

array[object]

required

List of portfolios allocations

Request

{
  "name": "Allocation 1",
  "allocation": [
    {
      "instrument_id": "IE00B0M62Q58",
      "instrument_id_type": "ISIN",
      "weight": "0.7"
    },
    {
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "weight": "0.3"
    }
  ]
}

Response

ExamplesSchema

Portfolios allocation

{
  "id": "436244bb-4afd-4002-b53b-b1d7a3bca032",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "name": "Allocation 1",
  "allocation": [
    {
      "instrument_id": "IE00B0M62Q58",
      "instrument_id_type": "ISIN",
      "weight": "0.7"
    },
    {
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "weight": "0.3"
    }
  ]
}

Retrieve portfolios allocation

get /portfolios/allocations/{allocation_id}

Retrieve portfolios allocation

allocation_id

string

uuid

required

Response

ExamplesSchema

Portfolios allocation

{
  "id": "bf5f2676-4535-403d-bc66-06ec38cc70af",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "name": "Allocation 1",
  "allocation": [
    {
      "instrument_id": "IE00B0M62Q58",
      "instrument_id_type": "ISIN",
      "weight": "0.7"
    },
    {
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "weight": "0.3"
    }
  ]
}

Update portfolios allocation

put /portfolios/allocations/{allocation_id}

Update portfolios allocation

name

string

Allocation name

allocation

array[object]

required

List of portfolios allocations

Request

{
  "allocation": [
    {
      "instrument_id": "IE00B0M62Q58",
      "instrument_id_type": "ISIN",
      "weight": "0.6"
    },
    {
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "weight": "0.4"
    }
  ]
}

Response

ExamplesSchema

Portfolios allocation

{
  "id": "436244bb-4afd-4002-b53b-b1d7a3bca032",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-22T15:10:00.00Z",
  "name": "Allocation 1",
  "allocation": [
    {
      "instrument_id": "IE00B0M62Q58",
      "instrument_id_type": "ISIN",
      "weight": "0.6"
    },
    {
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "weight": "0.4"
    }
  ]
}

List portfolios configurations

get /portfolios/configurations

List portfolios configurations

sort

string

Sort the result by account_id.

Default
"account_id"
Enum
  • account_id

order

string

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

Default
"ASC"
Enum
  • ASC

offset

int

int32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min
0

limit

int

int32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

start_date

string

Returns portfolio configurations with dates starting from and including this date (UTC)

Example
"2022-10-14"

end_date

string

Returns portfolio configurations with dates up until this date (UTC)

Example
"2022-10-14"

account_id

string

Filters portfolio configurations by account ID

Example
"3ada8e9e-82c4-4c78-a43d-a691b1636509"

allocation_id

string

Filters portfolio configurations by allocation ID

Example
"f6c2b02a-3214-4a40-82ae-6c76df50bc8c"

Response

ExamplesSchema

Portfolios configurations

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "account_id",
    "order": "ASC"
  },
  "data": [
    {
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "account_id": "4ca934ae-66b2-4494-86f9-df6ab89351f1",
      "allocation_id": "65c69f95-c7b9-4c93-9943-a8c7fe4f7aef",
      "rebalancing_strategy_ids": [
        "7a7322f5-b45d-4aba-aae4-c12797938c93",
        "d7b4291b-5a26-40c2-a8dd-235bd904a2ed"
      ]
    },
    {
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "account_id": "a46c4531-ec90-4ac3-ac6b-356d743a3859",
      "allocation_id": "a4117e26-7c31-43ad-af47-0784a4957da9",
      "rebalancing_strategy_ids": [
        "7a7322f5-b45d-4aba-aae4-c12797938c93",
        "692e318a-d6d0-43ac-999a-b84a82dbe304"
      ]
    }
  ]
}

Create portfolios configuration

post /portfolios/configurations

Create portfolios configuration

account_id

string

uuid

required

Account unique identifier.

allocation_id

string

uuid

required

rebalancing_strategy_ids

array[string]

List of rebalancing strategy ids

Request

{
  "account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
  "allocation_id": "eb68abce-29f4-483f-a384-7f243e77851f",
  "rebalancing_strategy_ids": [
    "7a7322f5-b45d-4aba-aae4-c12797938c93",
    "fd8e5363-a89c-4a2f-b3c6-5f857721625f"
  ]
}

Response

ExamplesSchema

Portfolios configuration

{
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
  "allocation_id": "eb68abce-29f4-483f-a384-7f243e77851f",
  "rebalancing_strategy_ids": [
    "7a7322f5-b45d-4aba-aae4-c12797938c93",
    "fd8e5363-a89c-4a2f-b3c6-5f857721625f"
  ]
}

Retrieve portfolios configuration

get /portfolios/configurations/{account_id}

Retrieve portfolios configuration

account_id

string

uuid

required

Account unique identifier.

Response

ExamplesSchema

Portfolios

{
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
  "allocation_id": "eb68abce-29f4-483f-a384-7f243e77851f",
  "rebalancing_strategy_ids": [
    "7a7322f5-b45d-4aba-aae4-c12797938c93",
    "fd8e5363-a89c-4a2f-b3c6-5f857721625f"
  ]
}

Update portfolios configuration

patch /portfolios/configurations/{account_id}

Update portfolios configuration

allocation_id

string

uuid

rebalancing_strategy_ids

array[string]

List of rebalancing strategy ids

Request

{
  "allocation_id": "359e9c9e-b91c-4853-8674-e6657af609fc"
}

Response

ExamplesSchema

Portfolio

{
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-22T15:10:00.00Z",
  "account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
  "allocation_id": "359e9c9e-b91c-4853-8674-e6657af609fc",
  "rebalancing_strategy_ids": [
    "7a7322f5-b45d-4aba-aae4-c12797938c93",
    "fd8e5363-a89c-4a2f-b3c6-5f857721625f"
  ]
}

List portfolios orders

get /portfolios/orders

List portfolios orders

sort

string

Sort the result by id.

Default
"id"
Enum
  • id

order

string

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

Default
"ASC"
Enum
  • ASC

offset

int

int32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min
0

limit

int

int32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

start_date

string

Returns portfolio orders with dates starting from and including this date (UTC)

Example
"2022-10-14"

end_date

string

Returns portfolio orders with dates up until this date (UTC)

Example
"2022-10-14"

allocation_id

string

uuid

Filters portfolio orders containing the allocation id

Example
"f96eaefd-b4c6-477a-9bbe-c744bf26172f"

account_id

string

uuid

Filters portfolio orders containing the account id

Example
"2c865aab-6737-4b0e-9154-69a4622b2727"