Get Account Info

Retrieves a summary of the user’s account, including wallet balance, margin details, and overall equity status.

This endpoint provides a comprehensive overview of the user’s account information, including total wallet balance, unrealized profit and loss (PnL), margin balance, reserved margin, and available balance. It is useful for tracking overall account equity, assessing margin utilization, and determining available funds for trading. The response also includes asset-level balance details for deeper financial visibility.

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

Get Account Info

get

Required scopes

This endpoint requires the following scopes:

Authorizations

thirdPartyApiKeyAuth

api-keystringRequired

For third party retail API users

Responses

200

OK

application/json

totalWalletBalancestringRequired

the total value of assets deposited in the wallet, excluding floating PnL.

Example: ###.###

totalUnrealizedPnlstringRequired

the net floating profit or loss from all currently open positions.

Example: ###.###

totalMarginBalancestringRequired

the total account equity.

Example: ###.###

totalMarginReservedstringRequired

the amount of margin currently locked and used for open positions or active orders.

Example: ###.###

availableBalancestringRequired

The remaining margin available for opening new positions or withdrawals

Example: ###.###

get

/api/v1/account

HTTPcURLJavaScriptPython

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

200

OK

{
  "totalWalletBalance": "###.###",
  "totalUnrealizedPnl": "###.###",
  "totalMarginBalance": "###.###",
  "totalMarginReserved": "###.###",
  "availableBalance": "###.###"
}