REST API›Trade›Margin

GET

List transferred collateral

Returns the balance of assets deposited as collateral for the specified account.

Path Params

  • accountId string required
    The ID of the account

Responses

200
A list of transferred collateral

Response Body

object

  • balances array of objects required
    balances object
    • currency string required
      Symbol of the collateral asset
    • quantity string required
      Number representing the balance for the specified collateral
    • balanceValue object required
      Returns the value of the collateral. Has 2 fields denoting the currency used and the actual value.
      balanceValue object
      • quantity string decimal required
        The specified quantity.
      • currency string required
        The specified quantity 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.