All portfolios related paths.
/portfolios/allocations
List portfolios allocations
sort
string
Sort the result by id
.
order
string
Sort order of the result list if the sort
parameter is specified. By default, only ASC for ascending sort.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
start_date
string
Returns portfolio allocations with dates starting from and including this date (UTC)
end_date
string
Returns portfolio allocations with dates up until this date (UTC)
instrument_ids
string
Filters portfolio allocations containing the instruments ID's
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"
}
]
}
]
}
/portfolios/allocations
Create portfolios allocation
name
string
Allocation name
allocation
array
required
List of portfolios allocations
instrument_id
One Of
required
Must match one of
instrument_id_type
string
required
The type of the ID used in the request.
weight
string
required
Instrument allocation weight
{
"name": "Allocation 1",
"allocation": [
{
"instrument_id": "IE00B0M62Q58",
"instrument_id_type": "ISIN",
"weight": "0.7"
},
{
"instrument_id": "US0378331005",
"instrument_id_type": "ISIN",
"weight": "0.3"
}
]
}
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"
}
]
}
/portfolios/allocations/{allocation_id}
Retrieve portfolios allocation
allocation_id
string
required
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"
}
]
}
/portfolios/allocations/{allocation_id}
Update portfolios allocation
name
string
Allocation name
allocation
array
required
List of portfolios allocations
instrument_id
One Of
required
Must match one of
instrument_id_type
string
required
The type of the ID used in the request.
weight
string
required
Instrument allocation weight
{
"allocation": [
{
"instrument_id": "IE00B0M62Q58",
"instrument_id_type": "ISIN",
"weight": "0.6"
},
{
"instrument_id": "US0378331005",
"instrument_id_type": "ISIN",
"weight": "0.4"
}
]
}
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"
}
]
}
/portfolios/configurations
List portfolios configurations
sort
string
Sort the result by account_id
.
order
string
Sort order of the result list if the sort
parameter is specified. By default, only ASC for ascending sort.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
start_date
string
Returns portfolio configurations with dates starting from and including this date (UTC)
end_date
string
Returns portfolio configurations with dates up until this date (UTC)
account_id
string
Filters portfolio configurations by account ID
allocation_id
string
Filters portfolio configurations by allocation ID
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"
]
}
]
}
/portfolios/configurations
Create portfolios configuration
account_id
string
required
Account unique identifier.
allocation_id
string
required
rebalancing_strategy_ids
array
List of rebalancing strategy ids
{
"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"
]
}
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"
]
}
/portfolios/configurations/{account_id}
Retrieve portfolios configuration
account_id
string
required
Account unique identifier.
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"
]
}
/portfolios/configurations/{account_id}
Update portfolios configuration
allocation_id
string
rebalancing_strategy_ids
array
List of rebalancing strategy ids
{
"allocation_id": "359e9c9e-b91c-4853-8674-e6657af609fc"
}
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"
]
}
/portfolios/orders
List portfolios orders
sort
string
Sort the result by id
.
order
string
Sort order of the result list if the sort
parameter is specified. By default, only ASC for ascending sort.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
start_date
string
Returns portfolio orders with dates starting from and including this date (UTC)
end_date
string
Returns portfolio orders with dates up until this date (UTC)
allocation_id
string
Filters portfolio orders containing the allocation id
account_id
string
Filters portfolio orders containing the account id
Portfolios orders
{
"meta": {
"offset": 0,
"limit": 100,
"count": 1,
"total_count": 1,
"sort": "id",
"order": "ASC"
},
"data": [
{
"id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
"created_at": "2021-07-21T14:10:00.000Z",
"updated_at": "2021-07-21T14:10:00.000Z",
"account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
"allocation_id": "eb68abce-29f4-483f-a384-7f243e77851f",
"cash_amount": "1000",
"currency": "EUR",
"status": "PROCESSING",
"type": "SELL",
"post_tax": false,
"client_reference": "",
"initiation_flow": "API",
"orders": [
{
"id": "b291d8a4-21f5-4c52-8590-4f90ce54d0b1",
"side": "SELL",
"status": "NEW"
},
{
"id": "81d02bd9-7b9d-443d-bbfa-31df4d543f7d",
"side": "SELL",
"status": "PROCESSING"
},
{
"id": "e97fb564-ebb4-4f37-930a-bda49c09a2e4",
"side": "SELL",
"status": "FILLED"
}
]
}
]
}
/portfolios/orders
Create portfolios order
user_id
string
required
User unique identifier.
account_id
string
required
Account unique identifier.
cash_amount
string
required
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
side
string
required
Side of the portfolio order.
post_tax
boolean
Cash amount is post-tax value
{
"user_id": "4b9732bd-7496-4e91-8a5f-6360479d7fed",
"account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
"cash_amount": "100.00",
"currency": "EUR",
"side": "BUY"
}
Portfolios order
{
"id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
"created_at": "2021-07-21T14:10:00.000Z",
"updated_at": "2021-07-21T14:10:00.000Z",
"account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
"allocation_id": "eb68abce-29f4-483f-a384-7f243e77851f",
"cash_amount": "1000",
"currency": "EUR",
"status": "NEW",
"type": "BUY",
"post_tax": false,
"client_reference": "",
"initiation_flow": "API",
"orders": []
}
/portfolios/orders/{portfolio_order_id}
Retrieve portfolios order
portfolio_order_id
string
required
Portfolios order
{
"id": "29bc9a26-a6ee-47a3-b609-47d30a737afc",
"created_at": "2021-07-21T14:10:00.00Z",
"updated_at": "2021-07-21T14:10:00.00Z",
"user_id": "4b9732bd-7496-4e91-8a5f-6360479d7fed",
"account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
"allocation_id": "19a902ac-1c01-4c45-bd5d-62fd496805c8",
"cash_amount": "100.00",
"currency": "EUR",
"status": "PROCESSING",
"type": "BUY",
"client_reference": "fd1ae99e-772a-11ee-b962-0242ac120002",
"initiation_flow": "SAVINGS_PLAN",
"post_tax": false,
"orders": [
{
"id": "79f2c816-13ed-4588-85e6-f3398b0b5825",
"side": "BUY",
"status": "NEW"
},
{
"id": "44f50a4e-7ce8-4eae-a078-f4b3d8ab4708",
"side": "BUY",
"status": "NEW"
}
]
}
/portfolios/orders/{portfolio_order_id}
Cancel portfolios order. Cancellations may not be possible - in rare situations, some individual orders within portfolios order may already have been filled. In this case, cancellation could result in a mix of cancelled and filled orders.
portfolio_order_id
string
required
The request has been successfully accepted and will be processed asynchronously.
Empty response
/portfolios/allocations/{allocation_id}/accounts
List portfolios allocation accounts
sort
string
Sort the result by id
.
order
string
Sort order of the result list if the sort
parameter is specified. By default, only ASC for ascending sort.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
Portfolios allocation accounts
{
"meta": {
"offset": 0,
"limit": 100,
"count": 1,
"total_count": 1,
"sort": "id",
"order": "ASC"
},
"data": [
{
"id": "81d6e710-37e6-4a5a-9877-ef5bb6d717e3"
}
]
}
id
string
required
Event unique identifier
created_at
string
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
object
object (Portfolios order)
required
id
string
required
created_at
string
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
user_id
string
User unique identifier.
account_id
string
required
Account unique identifier.
allocation_id
string
cash_amount
string
required
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
status
string
required
Execution status of the Portfolio Order.
type
string
Type of the Portfolio Order.
post_tax
boolean
required
Cash amount is post-tax value
orders
array
required
Orders associated with this portfolio order
client_reference
string
required
initiation_flow
string
required
What triggered the order creation .
cancellation_reason
string
Explains the reason why the order was cancelled .
cancellation_details
string
webhook_id
string
required
Webhook unique identifier.
{
"id": "54b8d84f-5bd0-4e43-bf0f-164388cb4c23",
"created_at": "2021-07-21T14:10:00.00Z",
"type": "PORTFOLIO_ORDER.NEW",
"object": {
"id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
"created_at": "2021-07-21T14:10:00.000Z",
"updated_at": "2021-07-21T14:10:00.000Z",
"account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
"allocation_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
"cash_amount": "1000",
"currency": "EUR",
"status": "PROCESSING",
"type": "SELL",
"post_tax": false,
"client_reference": "",
"initiation_flow": "API",
"orders": [
{
"id": "e7aecb80-5e84-4bf7-984b-b39ab77eb0a8",
"side": "SELL",
"status": "NEW"
},
{
"id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
"side": "SELL",
"status": "PROCESSING"
},
{
"id": "d8a85120-2941-4ed6-8d57-e80401a4779c",
"side": "SELL",
"status": "FILLED"
}
]
},
"webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}
Request has been processed successfully.
Empty response
id
string
required
Event unique identifier
created_at
string
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
object
object (Portfolios allocation)
required
id
string
required
created_at
string
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
name
string
required
Allocation name
allocation
array
required
List of portfolios allocations
webhook_id
string
required
Webhook unique identifier.
{
"id": "54b8d84f-5bd0-4e43-bf0f-164388cb4c23",
"created_at": "2021-07-21T14:10:00.00Z",
"type": "PORTFOLIO_ALLOCATION.CREATED",
"object": {
"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"
}
]
},
"webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}
Request has been processed successfully.
Empty response
Was this page helpful?