Orders

Get an order execution by ID

Returns the order execution specified by its ID. An execution represents a single trade fill within an order; an order may have multiple executions if it is partially filled across several trades.

See the Orders guide (TOL / BYOL / Omnibus) for execution lifecycle details.

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

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/orders/{order_id}/executions/{execution_id}
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: orders:read, orders:admin)

Response

OK

idstring uuid required
cash_amountstring required

A positive cash amount, as a decimal string with up to two decimal places.

share_quantitystring required

A positive decimal amount, as a string.

pricestring required

Price of an instrument for a trade execution provided as a decimal string.

transaction_timestring date-time required

Timestamp of when the trade was executed at the market. RFC 3339 date-time format.

order_idstring uuid required

Unique identifier for an order. Universally Unique Identifier (UUID).

status'FILLED' | 'SETTLED' | 'CANCELLED' required

Status of the execution.

  • FILLED — the execution has been filled.
  • SETTLED — the execution has settled and securities and cash have been exchanged.
  • CANCELLED — the execution was cancelled before settlement.
side'BUY' | 'SELL' required

Side of the execution.

  • BUY — a buy execution.
  • SELL — a sell execution.
currency'EUR' | 'GBP' | 'USD' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - British Pound
  • USD - US Dollar
settlement_datestring

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

venue_idstring uuid required

The ID of the venue

Changes

No recorded changes to this operation across all 25 revisions of this API.