> ## Documentation Index > Fetch the complete documentation index at: https://docs.vaults.fyi/llms.txt > Use this file to discover all available pages before exploring further. # Get transaction context > Retrieves the complete transactional context for a user's interaction with a specific vault, including available deposit/redeem steps, current balances, and claimable rewards. ## OpenAPI ````yaml https://api.vaults.fyi/v2/documentation/json get /v2/transactions/context/{userAddress}/{network}/{vaultId} openapi: 3.0.3 info: title: Vaults.fyi API version: 2.0.0 description: >- The Vaults.fyi V2 API offers a streamlined, better structured, and more performant interface for accessing DeFi vault data. This simplified version delivers optimized performance while maintaining comprehensive coverage across networks. Basic API key use is limited to 10 requests per minute. servers: - url: https://api.vaults.fyi description: Vaults.fyi API security: [] tags: - name: General description: >- Core informational endpoints providing essential reference data such as networks, assets, and vaults listings for orientation and exploration. - name: Detailed Vaults description: >- Comprehensive vault data endpoints delivering in-depth analytics including APY metrics, TVL statistics, rewards breakdowns, and risk scores. - name: Benchmarks description: >- Vaults.fyi curated benchmark endpoints providing aggregated yield performance data for USD and ETH denominated assets across selected networks. - name: Historical description: >- Endpoints returning time-series historical data for vault metrics, enabling trend analysis and performance tracking over customizable periods. - name: Portfolio description: >- Advanced endpoints providing detailed information about user balances, active positions, historical interactions, and tailored investment opportunities. - name: Transactions description: >- Endpoints for executing vault deposits, withdrawals, and reward claims with ready-to-sign transaction payloads. - name: NRT description: >- NRT (Near-Real-Time) endpoints return live vault data updated continuously throughout the day, including current share price, total supply, TVL, and APY. - name: Health paths: /v2/transactions/context/{userAddress}/{network}/{vaultId}: get: tags: - Transactions summary: Get transaction context description: >- Retrieves the complete transactional context for a user's interaction with a specific vault, including available deposit/redeem steps, current balances, and claimable rewards. operationId: getTransactionContext parameters: - schema: type: string pattern: ^0x[a-fA-F0-9]{40}$ in: path name: userAddress required: true description: User address - schema: type: string enum: - mainnet - optimism - arbitrum - polygon - gnosis - base - unichain - swellchain - celo - worldchain - berachain - ink - bsc - hyperliquid - plasma - avalanche - katana - linea - mega-eth - monad - etherlink - eip155:1 - eip155:10 - eip155:42161 - eip155:137 - eip155:100 - eip155:8453 - eip155:130 - eip155:1923 - eip155:42220 - eip155:480 - eip155:80094 - eip155:57073 - eip155:56 - eip155:999 - eip155:9745 - eip155:43114 - eip155:747474 - eip155:59144 - eip155:4326 - eip155:143 - eip155:42793 in: path name: network required: true description: Network name or CAIP-2 identifier - schema: type: string in: path name: vaultId required: true description: Vault id responses: '200': description: Transaction context information for a user and vault content: application/json: schema: type: object properties: currentDepositStep: type: string enum: - deposit - redeem - request-redeem - request-deposit - claim-redeem - claim-deposit - claim-rewards - start-redeem-cooldown description: Current deposit step depositSteps: type: array items: type: object properties: actions: type: array items: type: string actionsUrl: type: string name: type: string enum: - deposit - redeem - request-redeem - request-deposit - claim-redeem - claim-deposit - claim-rewards - start-redeem-cooldown required: - actions - actionsUrl - name additionalProperties: false description: Deposit steps currentRedeemStep: type: string enum: - deposit - redeem - request-redeem - request-deposit - claim-redeem - claim-deposit - claim-rewards - start-redeem-cooldown description: Current redeem step redeemSteps: type: array items: type: object properties: actions: type: array items: type: string actionsUrl: type: string name: type: string enum: - deposit - redeem - request-redeem - request-deposit - claim-redeem - claim-deposit - claim-rewards - start-redeem-cooldown required: - actions - actionsUrl - name additionalProperties: false description: Redeem steps lpToken: type: object properties: address: type: string pattern: ^0x[a-fA-F0-9]{40}$ description: Address of the LP token tokenCaip: type: string pattern: ^eip155:\d+\/(erc20:0x[0-9a-fA-F]{40}|slip44:\d+)$ description: CAIP-2 of the LP token name: type: string description: Name of the LP token symbol: type: string description: Symbol of the LP token decimals: type: integer description: Number of decimals of the LP token balanceNative: type: string description: Balance of the LP token balanceUsd: type: string description: USD value of the LP token required: - address - tokenCaip - name - symbol - decimals - balanceNative additionalProperties: false description: LP token details asset: type: object properties: address: type: string pattern: ^0x[a-fA-F0-9]{40}$ description: Address of the asset assetCaip: type: string pattern: ^eip155:\d+\/(erc20:0x[0-9a-fA-F]{40}|slip44:\d+)$ description: CAIP-2 of the asset name: type: string description: Name of the asset symbol: type: string description: Symbol of the asset decimals: type: integer description: Number of decimals of the asset assetLogo: type: string format: uri description: URL of the asset logo assetPriceInUsd: type: string description: Price of the asset in USD assetGroup: type: string description: Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER balanceNative: type: string description: Balance of the asset denominated in asset precision balanceUsd: type: string description: >- Balance of the asset denominated in usd. Omitted when no price is available. unclaimedNative: type: string description: >- Unclaimed balance of the asset in the position denominated in asset precision unclaimedUsd: type: string description: >- Unclaimed balance of the asset in the position denominated in usd positionValueInAsset: type: string description: Position value in asset denominated in asset precision depositLimit: type: string description: Maximum amount that can be deposited required: - address - assetCaip - name - symbol - decimals - assetGroup - balanceNative additionalProperties: false description: Asset details additionalAssets: type: array items: type: object properties: address: type: string pattern: ^0x[a-fA-F0-9]{40}$ description: Address of the asset assetCaip: type: string pattern: ^eip155:\d+\/(erc20:0x[0-9a-fA-F]{40}|slip44:\d+)$ description: CAIP-2 of the asset name: type: string description: Name of the asset symbol: type: string description: Symbol of the asset decimals: type: integer description: Number of decimals of the asset assetLogo: type: string format: uri description: URL of the asset logo assetPriceInUsd: type: string description: Price of the asset in USD assetGroup: type: string description: Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER balanceNative: type: string description: Balance of the asset denominated in asset precision balanceUsd: type: string description: >- Balance of the asset denominated in usd. Omitted when no price is available. unclaimedNative: type: string description: >- Unclaimed balance of the asset in the position denominated in asset precision unclaimedUsd: type: string description: >- Unclaimed balance of the asset in the position denominated in usd positionValueInAsset: type: string description: >- Position value in asset denominated in asset precision depositLimit: type: string description: Maximum amount that can be deposited required: - address - assetCaip - name - symbol - decimals - assetGroup - balanceNative additionalProperties: false description: Additional assets details childrenPositions: type: array items: type: object properties: address: type: string description: Address of the child vault lpToken: type: object properties: address: type: string pattern: ^0x[a-fA-F0-9]{40}$ description: Address of the LP token tokenCaip: type: string pattern: >- ^eip155:\d+\/(erc20:0x[0-9a-fA-F]{40}|slip44:\d+)$ description: CAIP-2 of the LP token name: type: string description: Name of the LP token symbol: type: string description: Symbol of the LP token decimals: type: integer description: Number of decimals of the LP token balanceNative: type: string description: Balance of the LP token balanceUsd: type: string description: USD value of the LP token required: - address - tokenCaip - name - symbol - decimals - balanceNative additionalProperties: false description: LP token details of the child vault asset: type: object properties: address: type: string pattern: ^0x[a-fA-F0-9]{40}$ description: Address of the asset assetCaip: type: string pattern: >- ^eip155:\d+\/(erc20:0x[0-9a-fA-F]{40}|slip44:\d+)$ description: CAIP-2 of the asset name: type: string description: Name of the asset symbol: type: string description: Symbol of the asset decimals: type: integer description: Number of decimals of the asset assetLogo: type: string format: uri description: URL of the asset logo assetPriceInUsd: type: string description: Price of the asset in USD assetGroup: type: string description: >- Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER balanceNative: type: string description: >- Balance of the asset denominated in asset precision balanceUsd: type: string description: >- Balance of the asset denominated in usd. Omitted when no price is available. unclaimedNative: type: string description: >- Unclaimed balance of the asset in the position denominated in asset precision unclaimedUsd: type: string description: >- Unclaimed balance of the asset in the position denominated in usd positionValueInAsset: type: string description: >- Position value in asset denominated in asset precision depositLimit: type: string description: Maximum amount that can be deposited required: - address - assetCaip - name - symbol - decimals - assetGroup - balanceNative additionalProperties: false description: Asset details of the child vault additionalAssets: type: array items: type: object properties: address: type: string pattern: ^0x[a-fA-F0-9]{40}$ description: Address of the asset assetCaip: type: string pattern: >- ^eip155:\d+\/(erc20:0x[0-9a-fA-F]{40}|slip44:\d+)$ description: CAIP-2 of the asset name: type: string description: Name of the asset symbol: type: string description: Symbol of the asset decimals: type: integer description: Number of decimals of the asset assetLogo: type: string format: uri description: URL of the asset logo assetPriceInUsd: type: string description: Price of the asset in USD assetGroup: type: string description: >- Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER balanceNative: type: string description: >- Balance of the asset denominated in asset precision balanceUsd: type: string description: >- Balance of the asset denominated in usd. Omitted when no price is available. unclaimedNative: type: string description: >- Unclaimed balance of the asset in the position denominated in asset precision unclaimedUsd: type: string description: >- Unclaimed balance of the asset in the position denominated in usd positionValueInAsset: type: string description: >- Position value in asset denominated in asset precision depositLimit: type: string description: Maximum amount that can be deposited required: - address - assetCaip - name - symbol - decimals - assetGroup - balanceNative additionalProperties: false description: Additional assets details of the child vault required: - address - lpToken - asset - additionalAssets additionalProperties: false vaultSpecificData: anyOf: - type: object properties: cooldownData: type: object properties: amount: type: string endOfCooldown: type: string withdrawalWindow: type: string status: type: string enum: - active - ready - expired required: - amount - endOfCooldown - withdrawalWindow - status additionalProperties: false additionalProperties: false - type: object properties: claimData: type: object properties: status: type: string enum: - none - pending - ready cooldownEnd: type: string assetAmount: type: string required: - status - cooldownEnd - assetAmount additionalProperties: false additionalProperties: false - type: object properties: claimData: type: array items: type: object properties: id: type: string status: type: string enum: - ready - pending lpTokenAmount: type: string assetAmount: type: string required: - id - status - lpTokenAmount - assetAmount additionalProperties: false required: - claimData additionalProperties: false - type: object properties: claimData: type: array items: type: object properties: id: type: string status: type: string enum: - ready - pending timestamp: type: string lpTokenAmount: type: string assetAmount: type: string required: - id - status - timestamp - lpTokenAmount - assetAmount additionalProperties: false required: - claimData additionalProperties: false - type: object properties: claimData: type: array items: type: object properties: lpTokenAmount: type: string assetAmount: type: string status: type: string enum: - ready - pending id: type: string required: - lpTokenAmount - assetAmount - status - id additionalProperties: false required: - claimData additionalProperties: false - type: object properties: requestData: type: object properties: claimableDeposit: type: string claimableRedeem: type: string pendingDeposit: type: string pendingRedeem: type: string redeemRequests: type: array items: type: object properties: timestamp: type: number lpTokenAmount: type: string isClaimable: type: boolean required: - timestamp - lpTokenAmount - isClaimable additionalProperties: false required: - claimableDeposit - claimableRedeem - pendingDeposit - pendingRedeem - redeemRequests additionalProperties: false required: - requestData additionalProperties: false - type: object properties: requestData: type: object properties: claimableDeposit: type: string claimableRedeem: type: string pendingDeposit: type: string pendingRedeem: type: string required: - claimableDeposit - claimableRedeem - pendingDeposit - pendingRedeem additionalProperties: false pendingRequests: type: array items: type: object properties: id: type: string type: type: string enum: - deposit - redeem status: type: string enum: - pending - ready assetAmount: type: string lpTokenAmount: type: string timestamp: type: number deadline: type: number required: - type - status additionalProperties: false required: - requestData - pendingRequests additionalProperties: false - type: object properties: redeemState: type: object properties: deadline: type: string rate: type: string lpTokenAmount: type: string assetAmount: type: string required: - deadline - rate - lpTokenAmount - assetAmount additionalProperties: false additionalProperties: false - type: object properties: claimData: type: object properties: lpTokenAmount: type: string assetAmount: type: string required: - lpTokenAmount - assetAmount additionalProperties: false eligible: type: boolean required: - eligible additionalProperties: false - type: object properties: pendingRequests: type: object properties: deposits: type: array items: type: object properties: amount: type: string deadline: type: string required: - amount - deadline additionalProperties: false redeems: type: array items: type: object properties: amount: type: string deadline: type: string required: - amount - deadline additionalProperties: false required: - deposits - redeems additionalProperties: false additionalProperties: false - type: object properties: pendingRequests: type: array items: type: object properties: id: type: string type: type: string enum: - deposit - redeem status: type: string enum: - pending - ready assetAmount: type: string lpTokenAmount: type: string timestamp: type: number deadline: type: number required: - type - status additionalProperties: false required: - pendingRequests additionalProperties: false - type: object properties: redeemFeeBips: type: string required: - redeemFeeBips additionalProperties: false - type: object properties: pendingRedeemRequest: type: object properties: assets: type: string shares: type: string required: - assets - shares additionalProperties: false liquidAssets: type: string required: - liquidAssets additionalProperties: false - type: object properties: requests: type: array items: type: object properties: status: type: string enum: - pending - executed - cancelled - unknown type: type: string enum: - subscription - redemption - unknown assetsAmount: type: string sharesAmount: type: string timestamp: type: number asset: type: string required: - status - type - assetsAmount - sharesAmount - timestamp - asset additionalProperties: false redemptionFeeBips: type: string required: - requests - redemptionFeeBips additionalProperties: false - type: object properties: pendingRequests: type: array items: type: object properties: id: type: string type: type: string enum: - deposit - redeem status: type: string enum: - pending - ready assetAmount: type: string lpTokenAmount: type: string timestamp: type: number deadline: type: number required: - type - status additionalProperties: false minDeposit: type: string minRedeem: type: string required: - pendingRequests - minDeposit - minRedeem additionalProperties: false - type: object properties: pendingWithdrawals: type: array items: type: object properties: assetAmount: type: string claimTimestamp: type: string required: - assetAmount - claimTimestamp additionalProperties: false additionalProperties: false - type: object properties: eligible: type: boolean kycUrl: type: string required: - eligible - kycUrl additionalProperties: false - type: object properties: {} additionalProperties: false pendingRequests: type: object properties: deposits: type: array items: type: object properties: status: type: string enum: - pending - ready assetAmount: type: string lpTokenAmount: type: string requestTimestamp: type: number estimatedResolution: type: number withdrawalStart: type: number withdrawalEnd: type: number required: - status additionalProperties: false redeems: type: array items: type: object properties: status: type: string enum: - pending - ready assetAmount: type: string lpTokenAmount: type: string requestTimestamp: type: number estimatedResolution: type: number withdrawalStart: type: number withdrawalEnd: type: number required: - status additionalProperties: false required: - deposits - redeems additionalProperties: false description: Pending requests rewards: type: object properties: claimable: type: array items: type: object properties: amount: type: string description: Amount of the claimable reward asset: type: object properties: address: type: string pattern: ^0x[a-fA-F0-9]{40}$ description: Address of the asset assetCaip: type: string pattern: >- ^eip155:\d+\/(erc20:0x[0-9a-fA-F]{40}|slip44:\d+)$ description: CAIP-2 of the asset name: type: string description: Name of the asset symbol: type: string description: Symbol of the asset decimals: type: integer description: Number of decimals of the asset assetLogo: type: string format: uri description: URL of the asset logo assetPriceInUsd: type: string description: Price of the asset in USD assetGroup: type: string description: >- Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER network: type: string enum: - mainnet - optimism - arbitrum - polygon - gnosis - base - unichain - swellchain - celo - worldchain - berachain - ink - bsc - hyperliquid - plasma - avalanche - katana - linea - mega-eth - monad - etherlink description: Network of the reward required: - address - assetCaip - name - symbol - decimals - assetGroup - network additionalProperties: false required: - amount - asset additionalProperties: false currentStep: type: string enum: - deposit - redeem - request-redeem - request-deposit - claim-redeem - claim-deposit - claim-rewards - start-redeem-cooldown description: Current step for claiming rewards steps: type: array items: type: object properties: actions: type: array items: type: string actionsUrl: type: string name: type: string enum: - deposit - redeem - request-redeem - request-deposit - claim-redeem - claim-deposit - claim-rewards - start-redeem-cooldown required: - actions - actionsUrl - name additionalProperties: false description: Steps for claiming rewards required: - claimable - currentStep - steps additionalProperties: false required: - currentDepositStep - depositSteps - currentRedeemStep - redeemSteps - lpToken - asset - additionalAssets - childrenPositions additionalProperties: false description: Transaction context information for a user and vault '400': description: Default Response content: application/json: schema: anyOf: - type: object properties: statusCode: type: number error: type: string enum: - Bad Request message: type: string errorId: type: string required: - statusCode - error - message additionalProperties: false - {} '401': description: Default Response content: application/json: schema: anyOf: - type: object properties: error: type: string enum: - Unauthorized message: type: string enum: - >- An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments. errorId: type: string required: - error - message additionalProperties: false - {} '402': description: Default Response content: application/json: schema: anyOf: - type: object properties: x402Version: anyOf: - type: number - type: string error: type: string resource: type: object properties: url: type: string description: type: string mimeType: type: string serviceName: type: string tags: type: array items: type: string iconUrl: type: string required: - url additionalProperties: false accepts: anyOf: - type: array items: type: object properties: scheme: type: string enum: - exact network: type: string amount: type: string payTo: type: string maxTimeoutSeconds: type: number asset: type: string extra: type: object properties: name: type: string version: type: string required: - name - version additionalProperties: false required: - scheme - network - amount - payTo - maxTimeoutSeconds - asset additionalProperties: false - {} extensions: type: object additionalProperties: {} required: - x402Version - resource additionalProperties: false - {} '403': description: Default Response content: application/json: schema: anyOf: - type: object properties: error: type: string enum: - Forbidden message: type: string enum: - >- This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits errorId: type: string required: - error - message additionalProperties: false - {} '404': description: Default Response content: application/json: schema: type: object properties: error: type: string enum: - Not Found message: type: string required: - error - message additionalProperties: false '408': description: Default Response content: application/json: schema: anyOf: - type: object properties: message: type: string errorId: type: string additionalProperties: false - {} '422': description: Default Response content: application/json: schema: anyOf: - type: object properties: statusCode: type: number error: type: string enum: - Unprocessable Entity message: type: string errorId: type: string required: - statusCode - error - message additionalProperties: false - {} '500': description: Default Response content: application/json: schema: anyOf: - type: object properties: error: type: string enum: - Internal Server Error message: type: string errorId: type: string required: - error - message additionalProperties: false - {} '503': description: Default Response content: application/json: schema: anyOf: - type: object properties: statusCode: type: number error: type: string enum: - Service Unavailable message: type: string errorId: type: string required: - statusCode - error - message additionalProperties: false - {} security: - apiKey: [] components: securitySchemes: apiKey: type: apiKey name: x-api-key in: header ````