Skip to main content
GET
/
executors
/
positions
/
summary
Get Positions Summary
curl --request GET \
  --url http://localhost:8000/executors/positions/summary \
  --header 'Authorization: Basic <encoded-value>'
{
  "total_positions": 123,
  "total_realized_pnl": 123,
  "positions": [
    {
      "trading_pair": "<string>",
      "connector_name": "<string>",
      "account_name": "<string>",
      "buy_amount_base": 123,
      "buy_amount_quote": 123,
      "sell_amount_base": 123,
      "sell_amount_quote": 123,
      "net_amount_base": 123,
      "buy_breakeven_price": 123,
      "sell_breakeven_price": 123,
      "matched_amount_base": 123,
      "unmatched_amount_base": 123,
      "position_side": "<string>",
      "realized_pnl_quote": 123,
      "executor_count": 123,
      "executor_ids": [
        "<string>"
      ],
      "last_updated": "<string>",
      "unrealized_pnl_quote": 123
    }
  ],
  "total_unrealized_pnl": 123
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200 - application/json

Successful Response

Summary of all held positions.

total_positions
integer
required

Number of active position holds

total_realized_pnl
number
required

Total realized PnL across all positions

positions
PositionHoldResponse · object[]
required

List of position holds

total_unrealized_pnl
number | null

Total unrealized PnL (None if no rates available)