# Phoenix

## Docs

- [Get wallet login nonce](https://docs.phoenix.trade/api/auth/get-wallet-login-nonce.md): Handles `GET /v1/auth/nonce` via `v1.auth.get_wallet_nonce`.
- [Log in with wallet signature](https://docs.phoenix.trade/api/auth/log-in-with-wallet-signature.md): Handles `POST /v1/auth/login/wallet` via `v1.auth.login_wallet`.
- [Log out](https://docs.phoenix.trade/api/auth/log-out.md): Handles `POST /v1/auth/logout` via `v1.auth.logout`.
- [Refresh session](https://docs.phoenix.trade/api/auth/refresh-session.md): Handles `POST /v1/auth/refresh` via `v1.auth.refresh_session`.
- [Get candles](https://docs.phoenix.trade/api/exchange/get-candles.md): Handles `GET /candles` via `public.candles.get`.
- [Get exchange](https://docs.phoenix.trade/api/exchange/get-exchange.md): Handles `GET /exchange` via `public.exchange.get`.
- [Get exchange keys](https://docs.phoenix.trade/api/exchange/get-exchange-keys.md): Handles `GET /exchange/keys` via `public.exchange.keys.get`.
- [Get exchange snapshot](https://docs.phoenix.trade/api/exchange/get-exchange-snapshot.md): Handles `GET /v1/exchange/snapshot` via `public.exchange.snapshot.get`.
- [Get market](https://docs.phoenix.trade/api/exchange/get-market.md): Handles `GET /exchange/market/{symbol}` via `public.exchange.market.get`.
- [Get next commodity market transition](https://docs.phoenix.trade/api/exchange/get-next-commodity-market-transition.md): Handles `GET /v1/market/next-commodity-market-transition` via `v1.market.next_commodity_market_transition.get`.
- [List markets](https://docs.phoenix.trade/api/exchange/list-markets.md): Handles `GET /exchange/markets` via `public.exchange.markets.get`.
- [API](https://docs.phoenix.trade/api/index.md): Phoenix REST and WebSocket API endpoints for market data, trader state, registration, and transaction building.
- [Activate invite](https://docs.phoenix.trade/api/registration/activate-invite.md): Redeems an invite code for an authority, inserts/updates activation rows atomically, triggers onboarding, and waits up to 15s for the trader PDA to appear in PhoenixState.
- [Activate referral](https://docs.phoenix.trade/api/registration/activate-referral.md): Activates a new trader using a referral code after verifying the authenticated user token owns the requested authority. Creates the user, claims the referral atomically, triggers onboarding, and waits up to 15s for the trader PDA to appear in PhoenixState.
- [Build attached conditional order transaction](https://docs.phoenix.trade/api/trader/build-attached-conditional-order-transaction.md): Handles `POST /v1/ix/place-attached-conditional-order` via `v1.place_attached_conditional_order_ix`.
- [Build cancel conditional order transaction](https://docs.phoenix.trade/api/trader/build-cancel-conditional-order-transaction.md): Handles `POST /v1/ix/cancel-conditional-order` via `v1.cancel_conditional_order_ix`.
- [Build cancel stop loss order transaction](https://docs.phoenix.trade/api/trader/build-cancel-stop-loss-order-transaction.md): Handles `POST /v1/ix/cancel-stop-loss-order` via `v1.cancel_stop_loss_order_ix`.
- [Build isolated limit order transaction](https://docs.phoenix.trade/api/trader/build-isolated-limit-order-transaction.md): Handles `POST /v1/ix/place-isolated-limit-order` via `v1.place_isolated_limit_order_ix`.
- [Build isolated limit order transaction with conditionals](https://docs.phoenix.trade/api/trader/build-isolated-limit-order-transaction-with-conditionals.md): Handles `POST /v1/ix/place-isolated-limit-order-with-conditionals` via `v1.place_isolated_limit_order_with_conditionals_ix`.
- [Build isolated limit order transaction with liquidation estimate](https://docs.phoenix.trade/api/trader/build-isolated-limit-order-transaction-with-liquidation-estimate.md): Handles `POST /v1/ix/place-isolated-limit-order-enhanced` via `v1.place_isolated_limit_order_enhanced_ix`.
- [Build isolated market order transaction](https://docs.phoenix.trade/api/trader/build-isolated-market-order-transaction.md): Handles `POST /v1/ix/place-isolated-market-order` via `v1.place_isolated_market_order_ix`.
- [Build isolated market order transaction with liquidation estimate](https://docs.phoenix.trade/api/trader/build-isolated-market-order-transaction-with-liquidation-estimate.md): Handles `POST /v1/ix/place-isolated-market-order-enhanced` via `v1.place_isolated_market_order_enhanced_ix`.
- [Build position conditional order transaction](https://docs.phoenix.trade/api/trader/build-position-conditional-order-transaction.md): Handles `POST /v1/ix/place-position-conditional-order` via `v1.place_position_conditional_order_ix`.
- [Build stop loss order transaction](https://docs.phoenix.trade/api/trader/build-stop-loss-order-transaction.md): Handles `POST /v1/ix/place-stop-loss-order` via `v1.place_stop_loss_order_ix`.
- [Get collateral history](https://docs.phoenix.trade/api/trader/get-collateral-history.md): Handles `GET /trader/{authority}/collateral-history` via `public.trader.collateral_history.get`.
- [Get funding history](https://docs.phoenix.trade/api/trader/get-funding-history.md): Handles `GET /trader/{authority}/funding-history` via `public.trader.funding_history.get`.
- [Get order history](https://docs.phoenix.trade/api/trader/get-order-history.md): Handles `GET /trader/{authority}/order-history` via `public.trader.order_history.get`.
- [Get trade history](https://docs.phoenix.trade/api/trader/get-trade-history.md): Handles `GET /trader/{authority}/trades-history` via `public.trader.trades_history.get`.
- [Get trader PnL](https://docs.phoenix.trade/api/trader/get-trader-pnl.md): Handles `GET /trader/{authority}/pnl` via `public.trader.pnl.get`.
- [Get trader state](https://docs.phoenix.trade/api/trader/get-trader-state.md): Handles `GET /trader/{authority}/state` via `public.trader.state.get`.
- [WebSocket](https://docs.phoenix.trade/api/websocket.md): Supported Phoenix WebSocket subscription requests and response message types.
- [Command reference](https://docs.phoenix.trade/cli/commands.md): Every Vulcan CLI command, grouped by topic.
- [CLI](https://docs.phoenix.trade/cli/index.md): Agent and human-friendly CLI for trading Phoenix perpetual futures on Solana.
- [Installation](https://docs.phoenix.trade/cli/installation.md): Install the Vulcan CLI and set up your wallet, configuration, and agent integrations.
- [Strategies](https://docs.phoenix.trade/cli/strategies.md): First-class strategy runners: TWAP, grid, and TA-driven trading on Phoenix perpetuals.
- [Getting Started](https://docs.phoenix.trade/index.md): What is Phoenix and how to connect your wallet
- [Accounts](https://docs.phoenix.trade/phoenix/collateral-and-accounts/accounts.md): How Phoenix accounts work and how cross and isolated risk differ
- [Collateral](https://docs.phoenix.trade/phoenix/collateral-and-accounts/collateral.md): How Phoenix uses USDC collateral
- [Cross-chain Deposits](https://docs.phoenix.trade/phoenix/collateral-and-accounts/cross-chain-deposits.md): How to deposit source tokens to Phoenix from other chains
- [Futures Rolling Mechanism](https://docs.phoenix.trade/phoenix/commodities/futures-rolling-mechanism.md)
- [Market Specs](https://docs.phoenix.trade/phoenix/commodities/market-specs.md)
- [Pricing](https://docs.phoenix.trade/phoenix/commodities/pricing.md)
- [FAQ](https://docs.phoenix.trade/phoenix/faq/faq.md): Answers to the most common execution, margin, and account questions
- [Support](https://docs.phoenix.trade/phoenix/faq/support.md): Get help and stay updated
- [Overview](https://docs.phoenix.trade/phoenix/flight.md): How Flight codes work on Phoenix
- [Glossary](https://docs.phoenix.trade/phoenix/glossary.md): Key Phoenix trading, execution, and risk terms
- [Account Health](https://docs.phoenix.trade/phoenix/margin-and-risk/account-health.md): How Phoenix turns collateral and margin into health states and risk tiers
- [Entry Price And PnL](https://docs.phoenix.trade/phoenix/margin-and-risk/entry-price-pnl.md): How Phoenix tracks entry price, unrealized PnL, and realized PnL
- [Funding](https://docs.phoenix.trade/phoenix/margin-and-risk/funding-rate.md): Funding rates keep perpetual prices aligned with spot prices through periodic payments between traders.
- [Leverage Tiers](https://docs.phoenix.trade/phoenix/margin-and-risk/leverage-tiers.md): How position size affects max leverage and margin
- [Risk Tiers And Liquidation](https://docs.phoenix.trade/phoenix/margin-and-risk/liquidations.md): Risk classification and liquidation types
- [Margin Math](https://docs.phoenix.trade/phoenix/margin-and-risk/margin-math.md): How Phoenix calculates effective collateral, position margin, and limit-order margin
- [Mark Price](https://docs.phoenix.trade/phoenix/margin-and-risk/mark-price.md): Mark price determines position valuations for PnL and liquidation calculations.
- [Risk Warning](https://docs.phoenix.trade/phoenix/margin-and-risk/risk-warning.md): Important risk disclosures
- [Phoenix Market Parameters](https://docs.phoenix.trade/phoenix/market-parameters.md): Phoenix Markets: Risk, Leverage, and Parameters
- [Fees](https://docs.phoenix.trade/phoenix/matching-engine/fees.md): Trading fees, liquidation fees, referral discounts, and Flight builder fees
- [FIFO Order Book](https://docs.phoenix.trade/phoenix/matching-engine/fifo-order-book.md): Price-time priority and user-facing orderbook behavior
- [Matching Engine](https://docs.phoenix.trade/phoenix/matching-engine/matching-engine.md): How Phoenix matches orders across the FIFO order book and spline liquidity
- [Order Types](https://docs.phoenix.trade/phoenix/matching-engine/order-types.md): Phoenix order types, matching behavior, and advanced order controls
- [Self-Trade Prevention](https://docs.phoenix.trade/phoenix/matching-engine/self-trade-prevention.md): How Phoenix handles orders that would match against your own liquidity
- [Spline Liquidity](https://docs.phoenix.trade/phoenix/matching-engine/spline-liquidity.md): How spline traders quote and fill liquidity on Phoenix
- [Take Profit and Stop Loss](https://docs.phoenix.trade/phoenix/matching-engine/take-profit-stop-loss.md): Attach conditional orders to positions or limit orders to close at a trigger price
- [Perpetual Futures](https://docs.phoenix.trade/phoenix/perpetual-futures.md): How Phoenix perpetual futures work, what makes them different from spot, and where each risk mechanism fits
- [Incentive Programs](https://docs.phoenix.trade/phoenix/referral-program.md): Incentive and referral programs on Phoenix
- [Auth](https://docs.phoenix.trade/sdk/auth.md): JWT lifecycle for authenticated Phoenix API and Rise SDK sessions.
- [Deposits and Withdrawals](https://docs.phoenix.trade/sdk/deposits-withdrawals.md): Build Phoenix USDC deposit and withdrawal transactions with the TypeScript and Rust SDKs.
- [Trader Onboarding](https://docs.phoenix.trade/sdk/onboarding.md): Activate Phoenix trader accounts with access codes or referral codes using the Rise SDK.
- [Rise SDK](https://docs.phoenix.trade/sdk/rise.md): Developer-facing SDK for Phoenix perpetuals, available in TypeScript and Rust

## OpenAPI Specs

- [phoenix-public-api](https://docs.phoenix.trade/openapi/phoenix-public-api.json)
- [openapi](https://docs.phoenix.trade/api-reference/openapi.json)