Ctrl+K

List Orders

get/trade-falcon/api/prime/trading/v1/admin/orders

Prime Trading

Query Parameters

  • offsetstring
    The amount to offset for pagination
  • idsstring
    List of order ID's you would like to get.
  • accountIdstring
    Orders associated with an accountId
  • statusstring
    Get orders by a status
  • sidestring
    Get orders by a trade side
  • startAtstring
    Get orders after a specific date
  • endAtstring
    Get orders before a specific date
  • settledboolean
    Get orders that have been settled

200 Response

Array of
id number <uuid>
The unique id of the order object
Example: 37617d48-9cd5-4d0a-8f41-b2d0bec2229b
externalClientOrderId string <uuid>
Id generated by external source
Example: 37617d48-9cd5-4d0a-8f41-b2d0bec2229b
accountId string
The user's account that initiated the trade
Example: 37617d48-9cd5-4d0a-8f41-b2d0bec2229b
status string
Indicates the overall status of the Order
Allowed values: canceled pending rejected settled failed
Example: pending
baseCurrency string
Currency type listed first in a trading pair
Allowed values: usd btc eth xrp ltc bch
Example: usd
quoteCurrency string
Currency type listed first in a trading pair
Allowed values: usd btc eth xrp ltc bch
Example: usd
side string
Side of the trade the user is on
Allowed values: buy sell
Example: buy
baseAmount string
Base currency amount to buy or sell
Example: 100000
quoteAmount string
Quote currency amount to buy or sell
Example: 100000
createdAt string <date-time>
ISO date string

400 Response

error string required
Human-readable error message
errorName string required
Immutable error code for API integration
reqId string required
Client request id