Skip to main content
GET
/
trader
/
{authority}
/
state
Get trader state
curl --request GET \
  --url https://perp-api.phoenix.trade/trader/{authority}/state
{
  "authority": "<string>",
  "pdaIndex": 1,
  "slot": 1,
  "slotIndex": 1,
  "traders": [
    {
      "accumulatedFunding": "<string>",
      "authority": "<string>",
      "cancelMargin": "<string>",
      "capabilities": {
        "depositCollateral": {
          "immediate": true,
          "viaColdActivation": true
        },
        "placeLimitOrder": {
          "immediate": true,
          "viaColdActivation": true
        },
        "placeMarketOrder": {
          "immediate": true,
          "viaColdActivation": true
        },
        "riskIncreasingTrade": {
          "immediate": true,
          "viaColdActivation": true
        },
        "riskReducingTrade": {
          "immediate": true,
          "viaColdActivation": true
        },
        "withdrawCollateral": {
          "immediate": true,
          "viaColdActivation": true
        }
      },
      "collateralBalance": "<string>",
      "discountedUnrealizedPnl": "<string>",
      "effectiveCollateral": "<string>",
      "effectiveCollateralForWithdrawals": "<string>",
      "flags": 1,
      "initialMargin": "<string>",
      "initialMarginForWithdrawals": "<string>",
      "isInActiveTraders": true,
      "lastDepositSlot": 1,
      "limitOrders": {},
      "maintenanceMargin": "<string>",
      "makerFeeOverrideMultiplier": 123,
      "maxPositions": 1,
      "portfolioValue": "<string>",
      "positions": [
        {
          "accumulatedFunding": "<string>",
          "backstopMargin": "<string>",
          "discountedUnrealizedPnl": "<string>",
          "entryPrice": "<string>",
          "initialMargin": "<string>",
          "limitOrderMargin": "<string>",
          "liquidationPrice": "<string>",
          "maintenanceMargin": "<string>",
          "positionInitialMargin": "<string>",
          "positionSize": "<string>",
          "positionValue": "<string>",
          "symbol": "<string>",
          "unrealizedPnl": "<string>",
          "unsettledFunding": "<string>",
          "virtualQuotePosition": "<string>",
          "stopLossPrice": "<string>",
          "takeProfitPrice": "<string>"
        }
      ],
      "riskState": "healthy",
      "riskTier": "safe",
      "slot": 1,
      "slotIndex": 1,
      "state": "uninitialized",
      "takerFeeOverrideMultiplier": 123,
      "traderKey": "<string>",
      "traderPdaIndex": 1,
      "traderSubaccountIndex": 1,
      "unrealizedPnl": "<string>",
      "unsettledFundingOwed": "<string>"
    }
  ]
}

Path Parameters

authority
string
required

Trader authority

Query Parameters

pdaIndex
integer<int32>
Required range: x >= 0

Response

200 - application/json

Trader state

authority
string
required
pdaIndex
integer<int32>
required
Required range: x >= 0
slot
integer<int64>
required
Required range: x >= 0
slotIndex
integer<int32>
required
Required range: x >= 0
traders
object[]
required