> ## 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 payload > Retrieves executable transaction payloads for specific actions (deposit, redeem, claim) for a user interacting with a vault, including ready-to-sign transaction data and optional simulation results. ## OpenAPI ````yaml https://api.vaults.fyi/v2/documentation/json get /v2/transactions/{action}/{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/{action}/{userAddress}/{network}/{vaultId}: get: tags: - Transactions summary: Get transaction payload description: >- Retrieves executable transaction payloads for specific actions (deposit, redeem, claim) for a user interacting with a vault, including ready-to-sign transaction data and optional simulation results. operationId: getTransaction parameters: - schema: type: boolean default: 'false' in: query name: simulate required: false description: 'DEPRECATED: This parameter is deprecated and no longer functional' - schema: type: string pattern: ^0x[a-fA-F0-9]{40}$ in: query name: assetAddress required: true description: Address of the asset to be used in the transaction - schema: type: string in: query name: amount required: false description: >- Only applicable to deposit, redeem, request-redeem, Amount of the asset to be used in the transaction - schema: type: boolean in: query name: all required: false description: >- Only applicable for redeem action. If true, all assets will be redeemed - schema: type: string enum: - deposit - redeem - request-redeem - request-deposit - claim-redeem - claim-deposit - claim-rewards - start-redeem-cooldown in: path name: action required: true description: Action to be performed - schema: type: string pattern: ^0x[a-fA-F0-9]{40}$ in: path name: userAddress required: true description: User address to get returns for - 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 to get returns for - schema: type: string in: path name: vaultId required: true description: Vault id to get returns for responses: '200': description: Default Response content: application/json: schema: type: object properties: currentActionIndex: type: number actions: type: array items: type: object properties: name: type: string description: Name of the action tx: type: object properties: to: type: string pattern: ^0x[a-fA-F0-9]{40}$ description: Address of the transaction recipient chainId: type: integer exclusiveMinimum: true minimum: 0 description: Chain ID of the transaction data: type: string description: Data to be sent with the transaction value: type: string description: Value to be sent with the transaction required: - to - chainId additionalProperties: false simulation: type: object properties: url: type: string description: URL to simulated transaction status: type: string enum: - success - failure - internal server error description: Status of the simulation tokensReceived: type: object additionalProperties: type: string description: Tokens received from the transaction tokensSpent: type: object additionalProperties: type: string description: Tokens spent in the transaction required: - url - status additionalProperties: false required: - name - tx additionalProperties: false required: - currentActionIndex - actions additionalProperties: false '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 ````