Orders

Orders

All order related paths.

get/accounts/{account_id}/orders

Get orders for an account by ID

Returns a list of all orders for the account specified by its ID.

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

account_group_idstring

Account group unique identifier.

Format: uuid

user_idstring

User unique identifier.

Format: uuid

statusstring

The execution status of the order.

NEW -
PROCESSING -
FILLED -
CANCELLED -

Default: "FILLED"
Enum: NEW
PROCESSING
FILLED
CANCELLED

date_created_fromstring

date range from

Format: date-time
Example: "2022-10-14T10:10:10Z"

date_created_tostring

date range to

Format: date-time
Example: "2022-10-14T10:10:10Z"

offsetint

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

Format: int32
Min: 0

limitint

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

Format: int32
Default: 100
Min: 0
Max: 1000

Responses

Response examples

{
  "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"
    }
  ]
}

post/orders

Place an order

Places a new order. After the creation request for the order is accepted, further processing takes place asynchronously.

user_idstring

required

The ID of the user

Format: uuid

account_idstring

required

The ID of the account that owns the order

Format: uuid

cash_amountstring

Cash amount for a nominal order, not required if a share quantity is specified.

Pattern: ^[0-9]{1,9}(\.[0-9]{2})?$

currencystring

The currency for the order.

Enum: EUR
GBP

sidestring

required

Side of the order.

BUY -
SELL -

Enum: BUY
SELL

instrument_idstring

required

International securities identification number defined by ISO 6166.

Pattern: ^[A-Z]{2}[A-Z0-9]{9}[0-9]$

instrument_id_typestring

required

The type of the ID used in the request.

ISIN -

Default: "ISIN"
Enum: ISIN

order_typestring

Type of the order.

MARKET -
LIMIT -
STOP -

Enum: MARKET
LIMIT
STOP

quantitystring

Quantity of securities for the order. Only required if the cash amount is not specified.

Pattern: ^[0-9]{0,63}(\.[0-9]{1,27})?$

user_instrument_fit_acknowledgementboolean

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_pricestring

The limit price for orders of the type 'limit'.

Pattern: ^[0-9]{0,63}(\.[0-9]{1,27})?$

stop_pricestring

The stop price for orders of the type 'stop'.

Pattern: ^[0-9]{0,63}(\.[0-9]{1,27})?$

expiry_datestring

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

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

client_referencestring

Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.

Max Length: 100

execution_flowstring

Execution flow that the order processing goes through. If no value is specified, the default value is assumed - STRAIGHT_THROUGH.

STRAIGHT_THROUGH -
BLOCK -

Enum: STRAIGHT_THROUGH
BLOCK

fee_configurationarray

fee configuration

Must match one of

Responses

Request examples

{
  "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": ""
}

Response examples

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"
}

get/orders/{order_id}

Get an order by ID

Returns the order specified by its ID.

order_idstring

required

Format: uuid

Responses

Response examples

{
  "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"
}

delete/orders/{order_id}

Cancel an order by 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_idstring

required

Format: uuid

Responses

Response examples

The order cancelling request is accepted.

{
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c"
}

get/orders/{order_id}/executions/{execution_id}

Get an order execution by ID

Returns the order execution specified by its ID.

execution_idstring

required

Format: uuid

order_idstring

required

Format: uuid

Responses

Response examples

{
  "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"
}

webhook

Orders events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

Event type

Enum: ORDER.NEW
ORDER.PROCESSING
ORDER.FILLED
ORDER.CANCELLED

objectobject (Order)

required

idstring

required

Format: uuid

created_atstring

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

Format: date-time

updated_atstring

required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

Format: date-time

user_idstring

required

The ID of the user

Format: uuid

account_idstring

required

The ID of the account that owns the order

Format: uuid

cash_amountstring

required

Cash amount for a nominal order, not required if a share quantity is specified.

Pattern: ^[0-9]{1,9}(\.[0-9]{2})?$

currencystring

required

The currency for the order.

Enum: EUR
GBP

sidestring

required

Side of the order.

BUY -
SELL -

Enum: BUY
SELL

instrument_idstring

required

International securities identification number defined by ISO 6166.

Pattern: ^[A-Z]{2}[A-Z0-9]{9}[0-9]$

instrument_id_typestring

required

The type of the ID used in the request.

ISIN -

Default: "ISIN"
Enum: ISIN

order_typestring

required

Type of the order.

MARKET -
LIMIT -
STOP -

Enum: MARKET
LIMIT
STOP

quantitystring

required

Quantity of securities for the order. Only required if the cash amount is not specified.

Pattern: ^[0-9]{0,63}(\.[0-9]{1,27})?$

user_instrument_fit_acknowledgementboolean

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_pricestring

The limit price for orders of the type 'limit'.

Pattern: ^[0-9]{0,63}(\.[0-9]{1,27})?$

stop_pricestring

The stop price for orders of the type 'stop'.

Pattern: ^[0-9]{0,63}(\.[0-9]{1,27})?$

expiry_datestring

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

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

statusstring

required

The execution status of the order.

NEW -
PROCESSING -
FILLED -
CANCELLED -

Enum: NEW
PROCESSING
FILLED
CANCELLED

feestring

required

Pattern: ^[0-9]{0,63}(\.[0-9]{1,27})?$

cancellation_reasonstring

Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED.

CANCELLED_BY_CLIENT -
CANCELLED_BY_UPVEST_OPERATIONS -
CANCELLED_BY_TRADING_PARTNER -
CANCELLED_BY_UPVEST_PLATFORM -

Enum: CANCELLED_BY_CLIENT
CANCELLED_BY_UPVEST_OPERATIONS
CANCELLED_BY_TRADING_PARTNER
CANCELLED_BY_UPVEST_PLATFORM

initiation_flowstring

required

Initiation flow used during order creation, i.e. what triggered the order.

API -
PORTFOLIO -
CASH_DIVIDEND_REINVESTMENT -
PORTFOLIO_REBALANCING -
SELL_TO_COVER_FEES -
SELL_TO_COVER_TAXES -
ACCOUNT_LIQUIDATION -
UPVEST_OPERATIONS -
SAVINGS_PLAN -

Enum: API
PORTFOLIO
CASH_DIVIDEND_REINVESTMENT
PORTFOLIO_REBALANCING
SELL_TO_COVER_FEES
SELL_TO_COVER_TAXES
ACCOUNT_LIQUIDATION
UPVEST_OPERATIONS
SAVINGS_PLAN

execution_flowstring

Execution flow that the order processing goes through. If no value is specified, the default value is assumed - STRAIGHT_THROUGH.

STRAIGHT_THROUGH -
BLOCK -

Enum: STRAIGHT_THROUGH
BLOCK

executionsarray

required

Order executions associated with this order

client_referencestring

required

Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.

Max Length: 100

fee_configurationarray

fee configuration

Must match one of

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "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"
}

Response examples

Request has been processed successfully.

Empty response

webhook

Executions events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

Event type

Enum: EXECUTION.FILLED
EXECUTION.SETTLED
EXECUTION.CANCELLED

objectobject (Order execution)

required

idstring

required

Format: uuid

cash_amountstring

required

Pattern: ^[0-9]{1,9}(\.[0-9]{2})?$

share_quantitystring

required

Pattern: ^[0-9]{0,63}(\.[0-9]{1,27})?$

pricestring

required

Pattern: ^[0-9]{0,63}(\.[0-9]{1,4})?$

transaction_timestring

required

Format: date-time

taxesarray

required

order_idstring

required

Format: uuid

statusstring

required

Execution status of the Execution.

FILLED -
SETTLED -
CANCELLED -

Enum: FILLED
SETTLED
CANCELLED

sidestring

required

Side of the execution.

BUY -
SELL -

Enum: BUY
SELL

currencystring

required

Alphabetic three-letter ISO 4217 currency code.

EUR - Euro
GBP - British Pound

Enum: EUR
GBP

settlement_datestring

Order execution settlement date in the YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$

venue_idstring

required

The ID of the venue

Format: uuid

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "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"
}

Response examples

Request has been processed successfully.

Empty response

webhook

Order Cancellations events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

Event type

Enum: ORDER_CANCELLATION.REJECTED

objectobject (Order Cancellation)

required

order_idstring

required

Format: uuid

statusstring

required

Status of the order cancellation process

Enum: REJECTED

reasonstring

Reason behind order cancellation rejection.

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "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"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?