Transactions

get

Retrieves the complete transactional context for a user's interaction with a specific vault, including available deposit/redeem steps, current balances, and claimable rewards.

Authorizations

apiKey

Path parameters

userAddressstringRequired

User address

Pattern: ^0x[a-fA-F0-9]{40}$

networkstring · enumRequired

Network name or CAIP-2 identifier

Possible values:

vaultAddressstringRequired

Vault address

Pattern: ^0x[a-fA-F0-9]{40}$

Responses

200

Transaction context information for a user and vault

application/json

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

408

Default Response

application/json

500

Default Response

application/json

503

Default Response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/transactions/context/{userAddress}/{network}/{vaultAddress} HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "currentDepositStep": "deposit",
  "depositSteps": [
    {
      "actions": [
        "text"
      ],
      "actionsUrl": "text",
      "name": "deposit"
    }
  ],
  "currentRedeemStep": "deposit",
  "redeemSteps": [
    {
      "actions": [
        "text"
      ],
      "actionsUrl": "text",
      "name": "deposit"
    }
  ],
  "lpToken": {
    "address": "text",
    "tokenCaip": "text",
    "name": "text",
    "symbol": "text",
    "decimals": 1,
    "balanceNative": "text",
    "balanceUsd": "text"
  },
  "asset": {
    "address": "text",
    "assetCaip": "text",
    "name": "text",
    "symbol": "text",
    "decimals": 1,
    "assetLogo": "https://example.com",
    "assetPriceInUsd": "text",
    "assetGroup": "text",
    "balanceNative": "text",
    "balanceUsd": "text",
    "unclaimedNative": "text",
    "unclaimedUsd": "text",
    "positionValueInAsset": "text"
  },
  "additionalAssets": [
    {
      "address": "text",
      "assetCaip": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 1,
      "assetLogo": "https://example.com",
      "assetPriceInUsd": "text",
      "assetGroup": "text",
      "balanceNative": "text",
      "balanceUsd": "text",
      "unclaimedNative": "text",
      "unclaimedUsd": "text",
      "positionValueInAsset": "text"
    }
  ],
  "childrenPositions": [
    {
      "address": "text",
      "lpToken": {
        "address": "text",
        "tokenCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1,
        "balanceNative": "text",
        "balanceUsd": "text"
      },
      "asset": {
        "address": "text",
        "assetCaip": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 1,
        "assetLogo": "https://example.com",
        "assetPriceInUsd": "text",
        "assetGroup": "text",
        "balanceNative": "text",
        "balanceUsd": "text",
        "unclaimedNative": "text",
        "unclaimedUsd": "text",
        "positionValueInAsset": "text"
      },
      "additionalAssets": [
        {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "balanceNative": "text",
          "balanceUsd": "text",
          "unclaimedNative": "text",
          "unclaimedUsd": "text",
          "positionValueInAsset": "text"
        }
      ]
    }
  ],
  "vaultSpecificData": null,
  "rewards": {
    "claimable": [
      {
        "amount": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "network": "mainnet"
        }
      }
    ],
    "currentStep": "deposit",
    "steps": [
      {
        "actions": [
          "text"
        ],
        "actionsUrl": "text",
        "name": "deposit"
      }
    ]
  }
}

get

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.

Authorizations

apiKey

Path parameters

actionstring · enumRequired

Action to be performed

Possible values:

userAddressstringRequired

User address to get returns for

Pattern: ^0x[a-fA-F0-9]{40}$

networkstring · enumRequired

Network to get returns for

Possible values:

vaultAddressstringRequired

Vault address to get returns for

Pattern: ^0x[a-fA-F0-9]{40}$

Query parameters

simulatebooleanOptional

Simulate the transaction

Default: false

assetAddressstringRequired

Address of the asset to be used in the transaction

Pattern: ^0x[a-fA-F0-9]{40}$

amountstringOptional

Only applicable to deposit, redeem, request-redeem, Amount of the asset to be used in the transaction

allbooleanOptional

Only applicable for redeem action. If true, all assets will be redeemed

Responses

200

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

408

Default Response

application/json

500

Default Response

application/json

503

Default Response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/transactions/{action}/{userAddress}/{network}/{vaultAddress}?assetAddress=text HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "currentActionIndex": 1,
  "actions": [
    {
      "name": "text",
      "tx": {
        "to": "text",
        "chainId": 1,
        "data": "text",
        "value": "text"
      },
      "simulation": {
        "url": "text",
        "status": "success",
        "tokensReceived": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "tokensSpent": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    }
  ]
}

get

Retrieves claimable rewards context for a user across all networks and vaults, including reward details and claim URLs.

Authorizations

apiKey

Path parameters

userAddressstringRequired

User address

Pattern: ^0x[a-fA-F0-9]{40}$

Responses

200

Rewards context information for claiming available rewards

application/json

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

408

Default Response

application/json

500

Default Response

application/json

503

Default Response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/transactions/rewards/context/{userAddress} HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "claimable": {
    "mainnet": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "optimism": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "arbitrum": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "polygon": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "gnosis": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "base": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "unichain": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "swellchain": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "celo": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "worldchain": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "berachain": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "ink": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "bsc": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "hyperliquid": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ],
    "plasma": [
      {
        "claimId": "text",
        "asset": {
          "address": "text",
          "assetCaip": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "assetLogo": "https://example.com",
          "assetPriceInUsd": "text",
          "assetGroup": "text",
          "claimableAmount": "text",
          "claimableAmountInUsd": "text"
        },
        "sources": [
          {
            "protocol": {
              "name": "text",
              "product": "text",
              "version": "text",
              "protocolUrl": "text",
              "protocolLogo": "text",
              "description": "text"
            }
          }
        ],
        "actionUrl": "text"
      }
    ]
  },
  "actionUrl": "text"
}

get

Generates a claim rewards transaction for a user, returning transaction payloads needed to claim rewards from protocols.

Authorizations

apiKey

Path parameters

userAddressstringRequired

User address to claim rewards for

Pattern: ^0x[a-fA-F0-9]{40}$

Query parameters

simulatebooleanOptional

Simulate the transaction

Default: false

claimIdsstring[]Required

Array of claim IDs to be claimed

Responses

200

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

403

Default Response

application/json

408

Default Response

application/json

500

Default Response

application/json

503

Default Response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/transactions/rewards/claim/{userAddress}?claimIds=text HTTP/1.1
Host: api.vaults.fyi
x-api-key: YOUR_API_KEY
Accept: */*

{
  "mainnet": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "optimism": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "arbitrum": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "polygon": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "gnosis": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "base": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "unichain": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "swellchain": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "celo": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "worldchain": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "berachain": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "ink": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "bsc": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "hyperliquid": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  },
  "plasma": {
    "currentActionIndex": 1,
    "actions": [
      {
        "name": "text",
        "tx": {
          "to": "text",
          "chainId": 1,
          "data": "text",
          "value": "text"
        },
        "simulation": {
          "url": "text",
          "status": "success",
          "tokensReceived": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "tokensSpent": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    ]
  }
}