Get Margin Info

Retrieves detailed margin information, including margin balance, unrealized PnL, and available funds for both cross and isolated margin modes.

This endpoint returns comprehensive margin data for the user's account. The response includes key metrics such as the total margin balance, unrealized profit and loss (PnL), and a breakdown of funds available or reserved for Cross and Isolated margin types. Users can optionally filter the response by a specific currency code to view margin details for a single asset.

Use this endpoint to monitor account health and manage trading risk. By tracking the cross margin ratio, initial margin reservations, and available isolated margin, traders can confirm they have sufficient collateral to support open positions or enter new trades without facing liquidation.

Authentication with a valid API key and read permission scope is required.

Get Margin Info

get

Required scopes

This endpoint requires the following scopes:

Authorizations

thirdPartyApiKeyAuth

api-keystringRequired

For third party retail API users

Query parameters

currencystringOptional

Currency code to filter margins

Responses

200

OK

application/json

get

/api/v1/account/margin

HTTPcURLJavaScriptPython

GET /api/v1/account/margin HTTP/1.1
Host: trading-api.flipster.io
api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "margins": [
    {
      "currency": "text",
      "isolatedMarginAvailable": "###.###",
      "unrealizedPnl": "###.###",
      "reservedForIsolatedMargin": "###.###",
      "reservedForIsolatedMarginPosition": "###.###",
      "crossMarginAvailable": "###.###",
      "marginBalance": "###.###",
      "crossMarginRatio": "###.###",
      "initMarginReserved": "###.###",
      "initPositionMargin": "###.###"
    }
  ]
}