> ## 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. # Claim rewards > Generates a claim rewards transaction for a user, returning transaction payloads needed to claim rewards from protocols. ## OpenAPI ````yaml https://api.vaults.fyi/v2/documentation/json get /v2/transactions/rewards/claim/{userAddress} 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/rewards/claim/{userAddress}: get: tags: - Transactions summary: Claim rewards description: >- Generates a claim rewards transaction for a user, returning transaction payloads needed to claim rewards from protocols. operationId: claimRewards parameters: - schema: type: boolean default: 'false' in: query name: simulate required: false description: 'DEPRECATED: This parameter is deprecated and no longer functional' - schema: type: array items: type: string minLength: 1 in: query name: claimIds required: true description: Array of claim IDs to be claimed - schema: type: string pattern: ^0x[a-fA-F0-9]{40}$ in: path name: userAddress required: true description: User address to claim rewards for responses: '200': description: Default Response content: application/json: schema: type: object required: - mainnet - optimism - arbitrum - polygon - gnosis - base - unichain - swellchain - celo - worldchain - berachain - ink - bsc - hyperliquid - plasma - avalanche - katana - linea - mega-eth - monad - etherlink properties: mainnet: 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 optimism: 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 arbitrum: 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 polygon: 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 gnosis: 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 base: 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 unichain: 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 swellchain: 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 celo: 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 worldchain: 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 berachain: 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 ink: 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 bsc: 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 hyperliquid: 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 plasma: 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 avalanche: 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 katana: 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 linea: 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 mega-eth: 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 monad: 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 etherlink: 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 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 ````