Orders

The Orders API allows you to view all orders (open, filled, expired, cancelled) for a single account.

Note, only accountId's that are created under your organization will be accessible.

API details

URL : /v1/orders/account/<accountId>

Method : GET

Auth required : Yes (API key and secret are required)

Success Response

Code : 200 OK

Returns an array of order statuses.

Sample response return:

[  {     "orderId": "12345",     "buy_or_sell": "BUY",     "trade_status": "OPEN",     "order_type": "LIMIT",     "limit_order_max_price": 4010.00,     "crypto_ticker": "ETH",     "amount": 0.023  },  {     "orderId": "56352",     "buy_or_sell": "SELL",     "fulfilled_datetime": "2021-11-12 13:21:01 GMT-06:00",     "trade_status": "FULFILLED",     "order_type": "MARKET",     "crypto_ticker": "BTC",     "amount": 0.002  },  {     "orderId": "41411",     "buy_or_sell": "SELL",     "trade_status": "USER_CANCELLED",     "order_type": "LIMIT",     "limit_order_max_price": 70000.00,     "crypto_ticker": "BTC",     "amount": 0.002  }]

- orderId - String. The unique identifier for the trade

- buy_or_sell - Enum. Either a BUY or SELL order

- fulfilled_datetime - String, datetime. Field only exists if order is fulfilled. Time and date of order fulfillment.

- order_status - Enum. Enum that represents the trade status. Enum options: FULFILLED, OPEN, USER_CANCELLED, EXPIRED, SYSTEM_CANCELLED

- order_type - Enum. Type of order. Options: LIMIT, MARKET

- limit_order_max_price - Double. REQUIRED if order_type is LIMIT. The maximum USD price to pay for the order. This price is the USD price for 1 complete coin, regardless of the amount in the order.

For example, if the user only wants to buy 0.5 ETH, the limit_order_max_price will be the max price paid for 1 ETH

- crypto_ticker - String. The ticker of the crypto for the order. Check this page for the cryptos we support

- amount - Double. The amount of the crypto ticker for the order

- time_in_force - Enum, optional. How long the order should will be open before expiring. By default, the time_in_force will be 60_DAYS. Options: 24_HOURS, 60_DAYS

Error Response

Code : 400 BAD REQUEST

Condition : If accountId is invalid or if organization does not have access to this account.