Get an order by ID

get https://live.moment-api.com/v1/aoms/order/{order_id}

Response

Response body

object

string

required

Moment-generated ULID identifier for the order

created_at

date-time

approved_at

date-time | null

filled_at

date-time | null

canceled_at

date-time | null

rejected_at

date-time | null

reason

string | null

The reason for an order rejection or cancellation.

client_order_id

string

Client-provided unique ID for the order; for example, to cross-reference with an internal system. Must be unique within the trading day, otherwise duplicate orders will be rejected during pre-trade checks.

instrument_id

string

required

Instrument ISIN

amount

double

required

The par value of the allocation.

filled_amount

double

The par value of the allocation.

filled_avg_price

object

Weighted average price that the order has been filled at so far, in each available pricing unit. Yields may be null if the order has not been executed or where unavailable.

pop

double

required

The Percentage Price is represented as a percentage of par. For a typical $1,000 par value bond, a percentage price of $90 values the bond at $900.

ytw

double | null

The Yield to Worst (YTW) is the lower of the Yield to Maturity (YTM) and the Yield to Call (YTC). The YTM represents the percentage rate of return for the investor assuming that the investor holds the bond to maturity, while the YTC represents the percentage rate of return for the investor assuming that the bond's issuer calls the bond at the least advantageous time and price for the investor. The YTW will always be less than or equal to the YTM.

ytm

double | null

The Yield to Maturity (YTM) represents the percentage rate of return for the investor, assuming the investor holds the bond to maturity.

side

string

required

Represents which side this order is on:

buy
sell

buy sell

limit_price

double

required

> 0

The Percentage Price is represented as a percentage of par. For a typical $1,000 par value bond, a percentage price of $90 values the bond at $900. This is a clean price, which does not include accrued interest.

accrued_interest

number

The cumulative amount of accrued interest for all trades made for an order, specified in the issuing currency. This amount is paid by the buyer in addition to the transaction value.

status

string

required

An order executed through Moment can experience several status changes during its lifecycle. The statuses are described in detail below:

pending_approval
The order has been received by Moment, and routed to the trading desk for approval. This is the initial state of an order.
pending_execution
The order has been received by Moment, approved by the trading desk, and routed to trading venues for execution.
partially_filled
The order has been partially filled.
filled
The order has been filled, and no further updates will occur for the order.
canceled
The order has been canceled, and no further updates will occur for the order. This can be due to a cancel request by the advisor, trading desk, or Moment.
rejected
The order has been rejected and no further updates will occur for the order.

An order may be canceled through the API up until the point it reaches a state of filled, rejected, or canceled.

pending_approval pending_execution partially_filled filled canceled rejected

annotation

string

Custom, arbitrary, client-provided metadata.

allocations

array of objects

allocations

object

allocation_id

string

Unique, Moment-generated ID for the allocation.

account_id

string

Unique ID of the user account

requested_amount

double

The par value of the allocation.

actual_amount

double

The par value of the allocation.

fill_price

double

> 0

status

string

created approved rejected submitted failed canceled

latest_msg_number

string

The msg_number for the most recent order event corresponding to this order, as per the Real-Time Orders API. This is a string representation of a 64-bit unsigned integer YYYYMMDDxxxxxxxxxx.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://live.moment-api.com/v1/aoms/order/order_id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response