REST APITradeOrders

GET

Lists trades from the trading account. This will include trades that have not yet settled.

Requires access token scope: trade_view

Path Params

  • accountId string required
    The ID of the account

Query Params

  • offset integer
  • limit integer
  • orderId string uuid
    The orderId of the trades to retrieve
  • dateGte string date-time
    Return trades with a trade date that is greater than or equal to the given timestamp
  • dateLt string date-time
    Return trades with a trade date that is less than the given timestamp
  • creationDateGte string date-time
    Return trades with a creation date that is greater than or equal to the given timestamp
  • creationDateLt string date-time
    Return trades with a creation date that is less than the given timestamp
  • isSettled boolean
    Return trades based on settlement status. true for settled trades, false for unsettled trades.
  • fundingType string enum
    Filter by funding type. 'funded' for available balance, 'margin' for margin balance.

    Defaults to funded

    marginfunded

Responses

200
An array of trades

Response Body

object

  • data array of objects required
    data object
    • id string uuid required
    • orderId string uuid required
    • time string date-time required
      The date when the trade occurred
    • creationDate string date-time required
      The date when the trade was created in our system
    • product string required
      Product name e.g. BTC-USD
    • side string enum required
      The side of the order
      buysell
    • price string decimal required
      Filled price, e.g. For BTC-USD product, 90000.00 USD
    • quoteQuantity string decimal required
      Filled quote quantity, e.g. For BTC-USD product, 100.50 USD
    • quantity string decimal required
      Filled base quantity, e.g. For BTC-USD product, 0.0045 BTC
    • fundingType string enum required

      The funding type of the order.

      • Funded orders will be placed using the Go account balance.
      • Margin orders will be placed using the margin account balances. See our Trade Guide for more details on each funding type.

      Defaults to funded

      marginfunded
    • settled boolean required
    • settleDate string date-time nullable
      The date when the trade was settled. Null if not yet settled.
    • accountId string required
      The ID of the account
    • enterpriseId string required
      The BitGo enterprise ID associated with this trade
400
Bad request - Invalid query parameters

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.
401
Unauthorized - Invalid or missing authentication

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.
403
Forbidden - Insufficient permissions

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.
500
Internal Server Error

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.