REST APITradeMargin

GET

Returns the list of currencies that are available for use as collateral.

Path Params

  • accountId string required
    The ID of the account

Responses

200
A list of available currencies for collateral

Response Body

object

  • availableCurrencies array of objects
    Returns a Currency object that consists of the ID, Name, Symbol, Increment, and PlatformSymbol for the instrument
    availableCurrencies object
    • id string uuid required
      ID of the currency
    • symbol string required
      Symbol of the currency
    • name string required
      Name of the currency
    • increment string decimal required
      This is the smallest amount that can be traded for the currency.
    • platformSymbol string
      The BitGo platform symbol for this currency.
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.