REST API›Trade›Margin

GET

Get net open margin position limits

Returns the asset-specific net open position limits for the specified account.

Path Params

  • accountId string required
    The ID of the account

Responses

200
Net open position limits

Response Body

object

  • netOpenPositionLimits array of objects
    netOpenPositionLimits object
    • enterpriseId string required
      The unique identifier for the enterprise (e.g., "enterprise-123").
    • currency string required
      The currency symbol for the net open position limit (e.g., "BTC").
    • shortMarginPositionNotionalLimit object required
      Quantity representing the notional limit for short margin positions in the specified currency (e.g., "1000000"). Currency represents the currency in which the quantity is valued (e.g., "BTC").
      shortMarginPositionNotionalLimit object
      • quantity string decimal required
        The specified quantity.
      • currency string required
        The specified quantity currency.
    • longMarginPositionNotionalLimit object required
      Quantity representing the notional limit for long margin positions in the specified currency (e.g., "2000000"). Currency represents the currency in which the quantity is valued (e.g., "BTC").
      longMarginPositionNotionalLimit 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.