All order related paths.

Get orders for an account by ID

get /accounts/{account_id}/orders

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

OAuth2 oauth-client-credentials

Required Scopes:

orders:readorders:admin

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • prices:read · Read instrument prices
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:admin · Create reports
  • reports:read · Read reports
  • savings_plans:admin · Create/read savings plans
  • savings_plans:read · Read savings plans
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • virtual_cash_balances:admin · Virtual cash balances
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

account_id

string

uuid

required

Account unique identifier.

order

string

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

offset

int

i32

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

i32

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

Default
100
Min
0
Max
1000

Response

Examples Schema

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"
            }
          ]
        }
      ],
      "client_reference": "",
      "initiation_flow": "API"
    }
  ]
}

Bad Request. The incoming request had a malformed parameter/object.

{
  "status": 400,
  "type": "bad_request"
}

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

meta

object (meta)

required

offset

int

required

Amount of resource to offset in the response.

limit

int

required

Total limit of the response.

count

int

required

Count of the resources returned in the response.

total_count

int

required

Total count of all the resources.

sort

string

The field that the list is sorted by.

order

string

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum
  • ASC
  • DESC

data

array[object (Order)]

required

Order

object (Order)

id

string

uuid

required

created_at

string

date-time

required

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

updated_at

string

date-time

required

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

user_id

string

uuid

required

The ID of the user

account_id

string

uuid

required

The ID of the account that owns the order

cash_amount

string

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

required

currency

string

ISO4217

required

Enum
  • EUR

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

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

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

required

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

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

required

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

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

stop_price

string

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

expiry_date

string

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

status

string

required

The execution status of the order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • CANCELLED -
Enum
  • NEW
  • PROCESSING
  • FILLED
  • CANCELLED

fee

string

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

required

cancellation_reason

string

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_flow

string

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 -
Enum
  • API
  • PORTFOLIO
  • CASH_DIVIDEND_REINVESTMENT
  • PORTFOLIO_REBALANCING
  • SELL_TO_COVER_FEES
  • SELL_TO_COVER_TAXES
  • ACCOUNT_LIQUIDATION
  • UPVEST_OPERATIONS

execution_flow

string

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

executions

array[object (Order execution)]

required

Order executions associated with this order

Order execution

object (Order execution)

id

string

uuid

required

cash_amount

string

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

required

share_quantity

string

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

required

price

string

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

required

transaction_time

string

date-time

required

taxes

array[object (Tax)]

required

Tax

object (Tax)

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

amount

string

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

required

order_id

string

uuid

required

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

settlement_date

string

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

client_reference

string

required

An ID provided by the client

Max Length
100

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Place an order

post /orders

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

OAuth2 oauth-client-credentials

Required Scopes:

orders:admin

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • prices:read · Read instrument prices
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:admin · Create reports
  • reports:read · Read reports
  • savings_plans:admin · Create/read savings plans
  • savings_plans:read · Read savings plans
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • virtual_cash_balances:admin · Virtual cash balances
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

idempotency-key

string

uuid

^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$

required

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/concepts/api_concepts/idempotency

Example
"ccb07f42-4104-44ad-8e1f-c660bb7b269c"

user_id

string

uuid

required

The ID of the user

account_id

string

uuid

required

The ID of the account that owns the order

cash_amount

string

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

currency

string

ISO4217

Enum
  • EUR

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

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

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

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

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

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

stop_price

string

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

expiry_date

string

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

client_reference

string

An ID provided by the client

Max Length
100

execution_flow

string

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

Request

{
  "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": ""
}
{
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "currency": "EUR",
  "side": "SELL",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "order_type": "MARKET",
  "quantity": "10",
  "user_instrument_fit_acknowledgement": true,
  "limit_price": "",
  "stop_price": ""
}

Response

Examples Schema

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"
}
{
  "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": "FILLED",
  "fee": "0.0",
  "executions": [
    {
      "id": "b9dc0676-8a7d-412d-802a-3b325eefd15e",
      "side": "BUY",
      "currency": "EUR",
      "status": "FILLED",
      "order_id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
      "cash_amount": "1000",
      "share_quantity": "11.734334663",
      "price": "85.22",
      "transaction_time": "2021-07-21T14:10:00.020Z",
      "taxes": [
        {
          "type": "TOTAL",
          "amount": "0"
        }
      ]
    }
  ],
  "client_reference": "",
  "initiation_flow": "API"
}
{
  "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": "0",
  "currency": "EUR",
  "side": "SELL",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "order_type": "MARKET",
  "quantity": "10",
  "user_instrument_fit_acknowledgement": true,
  "limit_price": "",
  "stop_price": "",
  "status": "NEW",
  "fee": "0.0",
  "executions": [],
  "client_reference": "",
  "initiation_flow": "API"
}
{
  "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": "0",
  "currency": "EUR",
  "side": "SELL",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "order_type": "MARKET",
  "quantity": "10",
  "user_instrument_fit_acknowledgement": true,
  "limit_price": "",
  "stop_price": "",
  "status": "FILLED",
  "fee": "0.0",
  "executions": [
    {
      "id": "b9dc0676-8a7d-412d-802a-3b325eefd15e",
      "side": "SELL",
      "currency": "EUR",
      "status": "FILLED",
      "order_id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
      "cash_amount": "852.20",
      "share_quantity": "10",
      "price": "85.22",
      "transaction_time": "2021-07-21T14:10:00.020Z",
      "taxes": [
        {
          "type": "TOTAL",
          "amount": "23.45"
        }
      ]
    }
  ],
  "client_reference": "",
  "initiation_flow": "API"
}

Bad Request. The incoming request had a malformed parameter/object.

{
  "status": 400,
  "type": "bad_request"
}

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

{
  "status": 406,
  "type": "not_acceptable"
}

Unprocessable Entity. The syntax of request is correct but server can't process it due a semantic error.

{
  "status": 422,
  "type": "unprocessable_entity"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

id

string

uuid

required

created_at

string

date-time

required

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

updated_at

string

date-time

required

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

user_id

string

uuid

required

The ID of the user

account_id

string

uuid

required

The ID of the account that owns the order

cash_amount

string

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

required

currency

string

ISO4217

required

Enum
  • EUR

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

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

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

required

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

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

required

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

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

stop_price

string

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

expiry_date

string

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

status

string

required

The execution status of the order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • CANCELLED -
Enum
  • NEW
  • PROCESSING
  • FILLED
  • CANCELLED

fee

string

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

required

cancellation_reason

string

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_flow

string

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 -
Enum
  • API
  • PORTFOLIO
  • CASH_DIVIDEND_REINVESTMENT
  • PORTFOLIO_REBALANCING
  • SELL_TO_COVER_FEES
  • SELL_TO_COVER_TAXES
  • ACCOUNT_LIQUIDATION
  • UPVEST_OPERATIONS

execution_flow

string

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

executions

array[object (Order execution)]

required

Order executions associated with this order

Order execution

object (Order execution)

id

string

uuid

required

cash_amount

string

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

required

share_quantity

string

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

required

price

string

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

required

transaction_time

string

date-time

required

taxes

array[object (Tax)]

required

Tax

object (Tax)

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

amount

string

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

required

order_id

string

uuid

required

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

settlement_date

string

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

client_reference

string

required

An ID provided by the client

Max Length
100

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Get an order by ID

get /orders/{order_id}

Returns the order specified by its ID.

OAuth2 oauth-client-credentials

Required Scopes:

orders:readorders:admin

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • prices:read · Read instrument prices
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:admin · Create reports
  • reports:read · Read reports
  • savings_plans:admin · Create/read savings plans
  • savings_plans:read · Read savings plans
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • virtual_cash_balances:admin · Virtual cash balances
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

order_id

string

uuid

required

Response

Examples Schema

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

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

id

string

uuid

required

created_at

string

date-time

required

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

updated_at

string

date-time

required

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

user_id

string

uuid

required

The ID of the user

account_id

string

uuid

required

The ID of the account that owns the order

cash_amount

string

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

required

currency

string

ISO4217

required

Enum
  • EUR

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

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

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

required

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

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

required

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

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

stop_price

string

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

expiry_date

string

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

status

string

required

The execution status of the order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • CANCELLED -
Enum
  • NEW
  • PROCESSING
  • FILLED
  • CANCELLED

fee

string

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

required

cancellation_reason

string

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_flow

string

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 -
Enum
  • API
  • PORTFOLIO
  • CASH_DIVIDEND_REINVESTMENT
  • PORTFOLIO_REBALANCING
  • SELL_TO_COVER_FEES
  • SELL_TO_COVER_TAXES
  • ACCOUNT_LIQUIDATION
  • UPVEST_OPERATIONS

execution_flow

string

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

executions

array[object (Order execution)]

required

Order executions associated with this order

Order execution

object (Order execution)

id

string

uuid

required

cash_amount

string

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

required

share_quantity

string

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

required

price

string

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

required

transaction_time

string

date-time

required

taxes

array[object (Tax)]

required

Tax

object (Tax)

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

amount

string

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

required

order_id

string

uuid

required

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

settlement_date

string

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

client_reference

string

required

An ID provided by the client

Max Length
100

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Cancel an order by ID

delete /orders/{order_id}

Cancels an order specified by its ID. It is possible to cancel an order of the NEW status. Once a cancellation has been accepted, the further processing steps take place asynchronously and depending on the respective order status.

OAuth2 oauth-client-credentials

Required Scopes:

orders:admin

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • prices:read · Read instrument prices
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:admin · Create reports
  • reports:read · Read reports
  • savings_plans:admin · Create/read savings plans
  • savings_plans:read · Read savings plans
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • virtual_cash_balances:admin · Virtual cash balances
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

order_id

string

uuid

required

Response

Examples Schema

The order cancelling request is accepted.

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

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

id

string

uuid

required

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Get an order execution by ID

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

Returns the order execution specified by its ID.

OAuth2 oauth-client-credentials

Required Scopes:

orders:readorders:admin

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • prices:read · Read instrument prices
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:admin · Create reports
  • reports:read · Read reports
  • savings_plans:admin · Create/read savings plans
  • savings_plans:read · Read savings plans
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • virtual_cash_balances:admin · Virtual cash balances
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

execution_id

string

uuid

required

order_id

string

uuid

required

Response

Examples Schema

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

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

id

string

uuid

required

cash_amount

string

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

required

share_quantity

string

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

required

price

string

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

required

transaction_time

string

date-time

required

taxes

array[object (Tax)]

required

Tax

object (Tax)

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

amount

string

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

required

order_id

string

uuid

required

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

settlement_date

string

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

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Orders events

webhook

Orders events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Event type

Enum
  • ORDER.NEW
  • ORDER.PROCESSING
  • ORDER.FILLED
  • ORDER.CANCELLED

object

object (object)

required

id

string

uuid

required

created_at

string

date-time

required

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

updated_at

string

date-time

required

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

user_id

string

uuid

required

The ID of the user

account_id

string

uuid

required

The ID of the account that owns the order

cash_amount

string

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

required

currency

string

ISO4217

required

Enum
  • EUR

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

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

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

required

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

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

required

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

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

stop_price

string

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

expiry_date

string

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

status

string

required

The execution status of the order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • CANCELLED -
Enum
  • NEW
  • PROCESSING
  • FILLED
  • CANCELLED

fee

string

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

required

cancellation_reason

string

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_flow

string

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 -
Enum
  • API
  • PORTFOLIO
  • CASH_DIVIDEND_REINVESTMENT
  • PORTFOLIO_REBALANCING
  • SELL_TO_COVER_FEES
  • SELL_TO_COVER_TAXES
  • ACCOUNT_LIQUIDATION
  • UPVEST_OPERATIONS

execution_flow

string

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

executions

array[object (Order execution)]

required

Order executions associated with this order

Order execution

object (Order execution)

id

string

uuid

required

cash_amount

string

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

required

share_quantity

string

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

required

price

string

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

required

transaction_time

string

date-time

required

taxes

array[object (Tax)]

required

Tax

object (Tax)

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

amount

string

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

required

order_id

string

uuid

required

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

settlement_date

string

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

client_reference

string

required

An ID provided by the client

Max Length
100

webhook_id

string

uuid

required

Webhook unique identifier.

Request

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

Request has been processed successfully.

Empty response

No schema

Executions events

webhook

Executions events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Event type

Enum
  • EXECUTION.FILLED
  • EXECUTION.SETTLED
  • EXECUTION.CANCELLED

object

object (object)

required

id

string

uuid

required

cash_amount

string

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

required

share_quantity

string

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

required

price

string

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

required

transaction_time

string

date-time

required

taxes

array[object (Tax)]

required

Tax

object (Tax)

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

amount

string

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

required

order_id

string

uuid

required

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

settlement_date

string

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

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "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": [
      {
        "amount": "0",
        "type": "TOTAL"
      }
    ],
    "transaction_time": "2022-11-17T10:42:34.758Z"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response

Examples Schema

Request has been processed successfully.

Empty response

No schema

Order Cancellations events

webhook

Order Cancellations events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Event type

Enum
  • ORDER_CANCELLATION.REJECTED

object

object (object)

required

order_id

string

uuid

required

status

string

required

Status of the order cancellation process

Enum
  • REJECTED

reason

string

Reason behind order cancellation rejection.

webhook_id

string

uuid

required

Webhook unique identifier.

Request

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

Request has been processed successfully.

Empty response

No schema

Was this page helpful?