Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Orders

Get Order

Retrieves the current state of an order.

  • Historical data prior to May 16, 2022 is unavailable.
get/profiles/{profile_id}/orders/{id}

Path parameters

profile_idstring required

The profile ID associated with the order.

idstring required

The UUID of the Order.

Response

A successful response.

idstring

The UUID of the order.

profile_idstring

The profile ID the order is associated with.

ref_idstring

The idempotence ID for order creation. Can be reused if the order has been closed for more than 24 hours.

status'PENDING_SUBMISSION' | 'SUBMITTED' | 'OPEN' | 'FILLED' | 'CANCELLED' | 'REJECTED' | 'EXPIRED'

Status of the order. The EXPIRED status is only applicable for Smart Order Routing customers.

side'BUY' | 'SELL'

Trade side.

market'ETHEUR' | 'ETHSGD' | 'ETHUSD' | 'BTCEUR' | 'BTCSGD' | 'BTCUSD' | 'PAXGUSD' | 'BCHUSD' | 'LTCUSD' | 'USDPUSD' | 'LINKUSD' | 'AAVEUSD' | 'UNIUSD' | 'PEPEUSD' | 'TRUMPUSD' | 'SHIBUSD' | 'ARBUSD' | 'BONKUSD' | 'ENAUSD' | 'MNTUSD' | 'ONDOUSD' | 'PENGUUSD' | 'QNTUSD' | 'RENDERUSD' | 'SKYUSD' | 'WIFUSD' | 'WLDUSD' | 'DOGEUSD' | 'AVAXUSD' | 'SUIUSD' | 'POLUSD' | 'XLMUSD' | 'BNBUSD'
type'LIMIT' | 'MARKET' | 'POST_ONLY_LIMIT' | 'STOP_MARKET' | 'STOP_LIMIT'

Trade type.

base_amountstring decimal

The base amount or purchase amount for a market sell order.

pricestring decimal

The quote price.

quote_amountstring decimal

The quote amount of purchase for a market buy order.

metadataobject

Client-specified metadata.

created_atstring date-time

The time at which the order was created.

modified_atstring date-time

The time at which the order was last modified.

amount_filledstring decimal

The amount that was filled.

volume_weighted_average_pricestring decimal

The volume-weighted average price.

time_in_force'GTC' | 'FOK' | 'IOC' | 'GTT'

How long an order will remain active before it expires.

  • Immediate-or-Cancel (IOC): Cancel if not executed immediately, partial fills allowed.
  • Good-Til-Canceled (GTC): Order can be canceled at any point until executed.
  • Good-Til-Time (GTT): Expires if not executed by a specified time. GTT must be greater than 10 seconds after the order is placed, otherwise the order will be rejected.
  • Fill-or-Kill (FOK): Fill entire order only or cancel entire order, does not allow for partial filling.

Time in Force validity for Order Types

Order typeImmediate or Cancel (IOC)Good Til Canceled (GTC)Good Til Time (GTT)Fill or Kill (FOK)
Market OrderDefault---
Limit OrderValidDefaultValidValid
Post Only LimitValidDefaultValidValid
Stop Market-DefaultValid-
Stop Limit-DefaultValid-
expiration_datestring date-time

The date the order will expire if not completed when specified time in force is GTT.

identity_idstring

The end user that requests the trade. This field must be used in conjunction with identity_account_id, otherwise the order is rejected. Depending on your integration type, identity_id and identity_account_id may be required.

identity_account_idstring

The account under which this order is placed. The provided identity must be allowed to trade on behalf of this account. This field must be used in conjunction with identity_id, otherwise the order is rejected. Depending on your integration type, identity_account_id and identity_id may be required.

stop_pricestring decimal
recipient_profile_idstring

The profileId that will receive settled currency (base for buy orders, quote for sell orders).

is_triggeredboolean

Returns true when a stop order has been triggered.