All order related paths.
/accounts/{account_id}/orders
Returns a list of all orders for the account specified by its ID.
order
string
Sort order of the result list if the sort
parameter is specified. Use ASC
for ascending or DESC
for descending sort order.
account_group_id
string
Account group unique identifier.
user_id
string
User unique identifier.
status
string
The execution status of the order.
date_created_from
string
date range from
date_created_to
string
date range to
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.
OK
{
"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.00Z",
"updated_at": "2021-07-21T14:10:00.00Z",
"user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
"account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
"cash_amount": "56.65",
"currency": "EUR",
"side": "BUY",
"instrument_id": "US0378331005",
"instrument_id_type": "ISIN",
"order_type": "MARKET",
"quantity": "0.05",
"user_instrument_fit_acknowledgement": true,
"limit_price": "",
"stop_price": "",
"status": "FILLED",
"fee": "0.5",
"executions": [
{
"id": "b9dc0676-8a7d-412d-802a-3b325eefd15e",
"side": "BUY",
"currency": "EUR",
"status": "FILLED",
"order_id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
"cash_amount": "56.65",
"share_quantity": "0.05",
"price": "130.65",
"transaction_time": "2021-07-21T14:10:00.00Z",
"taxes": [
{
"amount": "1.3",
"type": "TOTAL"
}
],
"venue_id": "20d6024b-2df4-41ae-8d42-62e4744e455b"
}
],
"client_reference": "",
"initiation_flow": "API"
}
]
}
/orders
Places a new order. After the creation request for the order is accepted, further processing takes place asynchronously.
user_id
string
required
The ID of the user
account_id
string
required
The ID of the account that owns the order
cash_amount
string
Cash amount for a nominal order, not required if a share quantity is specified.
currency
string
The currency for the order.
side
string
required
Side of the order.
instrument_id
string
required
International securities identification number defined by ISO 6166.
instrument_id_type
string
required
The type of the ID used in the request.
order_type
string
Type of the order.
quantity
string
Quantity of securities for the order. Only required if the cash amount is not specified.
user_instrument_fit_acknowledgement
boolean
Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.
limit_price
string
The limit price for orders of the type 'limit'.
stop_price
string
The stop price for orders of the type 'stop'.
expiry_date
string
The order expiration date (last day the order can trade) in the YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339. The default value is order creation date + 200 years
client_reference
string
An ID provided by the client
execution_flow
string
Execution flow that the order processing goes through. If no value is specified, the default value is assumed - STRAIGHT_THROUGH
.
fee_configuration
array
fee configuration
{
"user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
"account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
"cash_amount": "1000",
"currency": "EUR",
"side": "BUY",
"instrument_id": "US0378331005",
"instrument_id_type": "ISIN",
"order_type": "MARKET",
"user_instrument_fit_acknowledgement": true,
"limit_price": "",
"stop_price": ""
}
The request for the order creation has been accepted for processing.
{
"id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
"created_at": "2021-07-21T14:10:00.00Z",
"updated_at": "2021-07-21T14:10:00.00Z",
"user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
"account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
"cash_amount": "1000",
"currency": "EUR",
"side": "BUY",
"instrument_id": "US0378331005",
"instrument_id_type": "ISIN",
"order_type": "MARKET",
"quantity": "0",
"user_instrument_fit_acknowledgement": true,
"limit_price": "",
"stop_price": "",
"status": "NEW",
"fee": "0.0",
"executions": [],
"client_reference": "",
"initiation_flow": "API"
}
/orders/{order_id}
Returns the order specified by its ID.
order_id
string
required
OK
{
"id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
"created_at": "2021-07-21T14:10:00.00Z",
"updated_at": "2021-07-21T14:10:00.00Z",
"user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
"account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
"cash_amount": "56.65",
"currency": "EUR",
"side": "BUY",
"instrument_id": "US0378331005",
"instrument_id_type": "ISIN",
"order_type": "MARKET",
"quantity": "0.05",
"user_instrument_fit_acknowledgement": true,
"limit_price": "",
"stop_price": "",
"status": "NEW",
"fee": "0.5",
"executions": [],
"client_reference": "",
"initiation_flow": "API",
"execution_flow": "STRAIGHT_THROUGH"
}
/orders/{order_id}
Cancels an order specified by its ID. It is possible to cancel an order in the NEW
or PROCESSING
status. Once a cancellation has been accepted, the further processing steps take place asynchronously and depending on the respective order status.
order_id
string
required
The order cancelling request is accepted.
{
"id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c"
}
/orders/{order_id}/executions/{execution_id}
Returns the order execution specified by its ID.
execution_id
string
required
order_id
string
required
OK
{
"id": "b9dc0676-8a7d-412d-802a-3b325eefd15e",
"side": "BUY",
"currency": "EUR",
"status": "SETTLED",
"order_id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
"cash_amount": "56.65",
"share_quantity": "0.05",
"price": "130.65",
"transaction_time": "2021-07-21T14:10:00.00Z",
"taxes": [
{
"amount": "1.3",
"type": "TOTAL"
}
],
"settlement_date": "2021-07-23",
"venue_id": "20d6024b-2df4-41ae-8d42-62e4744e455b"
}
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 (Order)
required
webhook_id
string
required
Webhook unique identifier.
{
"id": "8962b496-8d42-4560-bfab-10490dd1a721",
"created_at": "2021-07-21T14:10:00.00Z",
"type": "ORDER.NEW",
"object": {
"id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
"created_at": "2021-07-21T14:10:00.00Z",
"updated_at": "2021-07-21T14:10:00.00Z",
"user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
"account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
"cash_amount": "56.65",
"currency": "EUR",
"side": "BUY",
"instrument_id": "US0378331005",
"instrument_id_type": "ISIN",
"order_type": "MARKET",
"quantity": "0.05",
"user_instrument_fit_acknowledgement": true,
"limit_price": "",
"stop_price": "",
"status": "NEW",
"fee": "0.5",
"executions": [],
"client_reference": "",
"initiation_flow": "API"
},
"webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}
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 (Order execution)
required
webhook_id
string
required
Webhook unique identifier.
{
"id": "8962b496-8d42-4560-bfab-10490dd1a721",
"created_at": "2022-11-17T10:42:34.758Z",
"type": "EXECUTION.FILLED",
"object": {
"cash_amount": "852.20",
"currency": "EUR",
"id": "b40f4631-e83b-4737-a003-c0cb36382bc5",
"order_id": "cd2d6019-c11d-4114-aab3-b2e5dbe58cbf",
"price": "85.22",
"share_quantity": "10",
"side": "BUY",
"status": "FILLED",
"taxes": [
{
"type": "TOTAL",
"amount": "0"
}
],
"transaction_time": "2022-11-17T10:42:34.758Z",
"venue_id": "20d6024b-2df4-41ae-8d42-62e4744e455b"
},
"webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}
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 (Order Cancellation)
required
webhook_id
string
required
Webhook unique identifier.
{
"id": "e0b1f0ac-d34a-4f07-b268-545278110231",
"created_at": "2023-08-01T14:10:00.00Z",
"type": "ORDER_CANCELLATION.REJECTED",
"object": {
"order_id": "120c5382-d400-4a8e-95fc-d297903f3568",
"status": "REJECTED",
"reason": "Cancellation not possible"
},
"webhook_id": "0e225118-168c-4d4d-84d9-c36096163162"
}
Request has been processed successfully.
Empty response
Was this page helpful?