Skip to main content

Retrieve order

GET 
/v1/orders/:id

Retrieves the order for the given id.

Request​

Path Parameters

    id stringrequired

Responses​

Your request has been successfully processed.

Schema

    id stringrequired

    Unique identifier for the order

    order_type OrderType (string)required

    Order type may be either limit order or market order.

    Possible values: [limit, market]

    Default value: limit
    order_state stringrequired

    Current fulfillment state of the order

    client_order_id stringrequired

    Client's unique identifier for the order.

    buy_currency stringrequired

    The currency that you want to buy.

    sell_currency stringrequired

    The currency that you want to sell.

    buy_amount double

    The amount that you want to buy.

    sell_amount double

    The amount that you want to sell.

    tenor TenorREST (string)required

    The tenor value for the quote e.g. SPOT, CASH (T+0), NEXT DAY (T+1)

    Possible values: [SPOT, TOD, TOM]

    Default value: SPOT
    Example: SPOT
    sources string[]

    Restrict quotes to specified sources.

    limit_price double

    limit price for the order using market conventions. Valid for limit orders only.

    order_notes string

    Order notes.

    Possible values: <= 256 characters

    status

    object

    Order status for the specified order id.

    status stringrequired

    Order status for given order id.

    Possible values: [pending, filled, killed]

    timestamp date-time

    Timestamp of last status update.

Loading...