> ## Documentation Index > Fetch the complete documentation index at: https://docs.hedgin.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Get Phoenix state > Requires key scope `read`. Returns the vault's Phoenix trader status, markets, open orders, withdrawable collateral, and margin account. `openOrders` carries the `priceInTicks` and `orderSequenceNumber` that a by-id `phoenix/cancel` needs. Fields that come from Phoenix are `null` when Phoenix data is unavailable. The data can be up to 10 seconds old. ## OpenAPI ````yaml /api-reference/openapi.json get /vaults/{vault}/phoenix openapi: 3.1.0 info: title: Hedgin manager bot API version: 1.0.0 description: >- Versioned HTTP API for approved manager bots. Reads vault state and builds unsigned Solana transactions. The bot signs locally with the vault's current authority key. Runs only on Solana mainnet-beta. servers: - url: https://hedgin.xyz/api/external/v1 description: Production (Solana mainnet-beta) security: - bearerAuth: [] tags: - name: Vault reads - name: Market reads - name: Jupiter transactions - name: Meteora DLMM transactions - name: Phoenix transactions - name: Vault and strategy transactions - name: Send and status paths: /vaults/{vault}/phoenix: get: tags: - Vault reads summary: Get Phoenix state description: >- Requires key scope `read`. Returns the vault's Phoenix trader status, markets, open orders, withdrawable collateral, and margin account. `openOrders` carries the `priceInTicks` and `orderSequenceNumber` that a by-id `phoenix/cancel` needs. Fields that come from Phoenix are `null` when Phoenix data is unavailable. The data can be up to 10 seconds old. operationId: getVaultPhoenix parameters: - name: vault in: path required: true description: >- Vault public key. Must be in the key's allowlist when the key has one, and the key's manager must be the vault's current on-chain authority. schema: $ref: '#/components/schemas/PublicKey' responses: '200': description: The vault address and its data. content: application/json: schema: type: object required: - vault - data properties: vault: $ref: '#/components/schemas/PublicKey' data: $ref: '#/components/schemas/PhoenixManagerView' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' '503': $ref: '#/components/responses/ServiceUnavailable' components: schemas: PublicKey: type: string description: >- Base58 Solana public key. The server decodes it and rejects anything that is not 32 bytes. pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$ example: So11111111111111111111111111111111111111112 PhoenixManagerView: type: object properties: status: type: string enum: - none - registered - ready description: >- `none`: no Phoenix strategy. `registered`: strategy exists, trader not onboarded. `ready`: can deposit and trade. usdcVault: type: boolean description: Phoenix strategies need a USDC deposit mint. traderAccount: $ref: '#/components/schemas/PublicKey' markets: type: array items: type: object properties: symbol: type: string name: type: string category: type: string enum: - crypto - commodities - equities logoUri: type: - string - 'null' color: type: - string - 'null' maxLeverage: type: number maintenanceFactor: type: number markPrice: type: string description: USD per base unit. `"0"` when the mark is unavailable. tickSize: type: number baseLotsDecimals: type: integer takerFee: type: number makerFee: type: number openOrders: type: - array - 'null' description: '`null` when Phoenix data is unavailable.' items: type: object properties: symbol: type: string side: type: string enum: - long - short price: type: string size: type: string priceInTicks: $ref: '#/components/schemas/U64String' orderSequenceNumber: $ref: '#/components/schemas/U64String' reduceOnly: type: boolean withdrawable: type: - string - 'null' description: >- USDC base units withdrawable while the account stays healthy. `null` when Phoenix data is unavailable. account: type: - object - 'null' properties: collateral: type: string equity: type: string initialMargin: type: string maintenanceMargin: type: string withdrawable: type: string riskState: type: string liquidationPrices: type: object additionalProperties: type: string U64String: type: string description: Unsigned 64-bit integer as a decimal string of at most 20 digits. pattern: ^\d{1,20}$ Error: type: object description: >- Every error response uses this envelope. Responses with status 500, 502, or 503 always carry the message `Service temporarily unavailable`. Responses with status 422 always carry the message `Transaction rejected during simulation or preflight`. In both cases `code` still names the cause. required: - error properties: error: type: object required: - code - message properties: code: type: string description: >- Stable machine-readable code, such as `Validation`, `Forbidden`, or a decoded program error name. example: Validation message: type: string description: Human-readable detail. Never contains provider logs. example: vault must be a public key responses: BadRequest: description: >- Invalid path, query, or body. Builder messages name the field, such as `amount: must be a non-negative integer string`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: Validation message: vault must be a public key Unauthorized: description: Missing, malformed, unknown, revoked, or expired API key. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: Unauthorized message: Invalid API key Forbidden: description: >- The key lacks the required scope, the vault is outside the key's allowlist, or the key's manager is not the vault's current on-chain authority. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: Forbidden message: Action is not enabled for this key NotFound: description: Unknown route, or the vault, mint, pool, or strategy does not exist. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: NotFound message: Vault not found TooManyRequests: description: A rate limit is exhausted. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: RateLimited message: Too many requests, slow down InternalError: description: >- Internal error, including a builder that returned an invalid transaction (`BuildFailed`). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: Internal message: Service temporarily unavailable ServiceUnavailable: description: RPC, key store, or service configuration unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: RpcUnavailable message: Service temporarily unavailable securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: hv1__ description: >- API key issued by a Hedgin administrator, in the form `hv1__`. `` is 1 to 48 characters and `` is 32 to 128 characters, both from `[A-Za-z0-9_-]`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.