Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-2265155163.6 KB
Trader

Get trader

Handles GET /v1/view/trader/{pubkey} via get.v1.view.trader.by_pubkey.

get/v1/view/trader/{pubkey}

Path parameters

pubkeystring required

Base58 encoded trader account pubkey

Response

Phoenix Eternal trader

accumulatedFundingstring required

Accumulated funding amount.

authoritystring required

Trader authority public key.

cancelMarginstring required

Margin threshold used for cancellation checks.

collateralBalancestring required

Collateral balance.

discountedUnrealizedPnlstring required

Discounted unrealized PnL used in risk calculations.

effectiveCollateralstring required

Effective collateral used for risk checks.

effectiveCollateralForWithdrawalsstring required

Effective collateral used for withdrawal checks.

flagsinteger required

Canonical capability mask stored in every trader header. The derived preset constructors (cold, hot_active, reduce_only, frozen) preserve the intended behavioural guarantees: cold traders operate from their local buffer until warmed, active traders have full matching-engine access, reduce-only traders may only take risk-reducing actions (but can still move collateral), and frozen traders are fully quarantined with balance transfers disabled.

initialMarginstring required

Required initial margin.

initialMarginForWithdrawalsstring required

Initial margin used for withdrawal checks.

isInActiveTradersboolean required

Whether trader is currently in the active-trader buffer.

lastDepositSlotinteger required

Last collateral deposit slot.

limitOrdersobject required

Open limit orders grouped by symbol.

maintenanceMarginstring required

Required maintenance margin.

makerFeeOverrideMultipliernumber double required

Maker fee multiplier (1.0 = default, <1.0 = discount, >1.0 = premium).

maxPositionsinteger required

Maximum number of positions allowed.

numMarketsWithSplinesinteger required

Number of markets where this trader has registered splines

portfolioValuestring required

Current portfolio value.

riskState'healthy' | 'unhealthy' | 'underwater' | 'zeroCollateralNoPositions' required
riskTier'safe' | 'atRisk' | 'cancellable' | 'liquidatable' | 'backstopLiquidatable' | 'highRisk' required
slotinteger required

Solana slot of the state snapshot used to build this trader view.

slotIndexinteger required

Intra-slot sequence index of the state snapshot used to build this trader view.

state'uninitialized' | 'cold' | 'active' | 'reduceOnly' | 'frozen' required

Serializable representation of a trader's high-level activity state.

takerFeeOverrideMultipliernumber double required

Taker fee multiplier (1.0 = default, <1.0 = discount, >1.0 = premium).

traderKeystring required

Trader PDA public key.

traderPdaIndexinteger required

Trader PDA index under the authority.

traderSubaccountIndexinteger required

Trader subaccount index.

unrealizedPnlstring required

Total unrealized PnL.

unsettledFundingOwedstring required

Unsettled funding amount owed to the trader.

  • Positive value = funding you will receive when settled (increases collateral)
  • Negative value = funding you owe when settled (decreases collateral)