Transactions
Retrieves the complete transactional context for a user's interaction with a specific vault, including available deposit/redeem steps, current balances, and claimable rewards.
User address
^0x[a-fA-F0-9]{40}$
Network name or CAIP-2 identifier
Vault address
^0x[a-fA-F0-9]{40}$
Transaction context information for a user and vault
Default Response
Default Response
Default Response
Default Response
Default Response
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",
"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",
"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",
"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",
"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",
"network": "mainnet"
}
}
],
"currentStep": "deposit",
"steps": [
{
"actions": [
"text"
],
"actionsUrl": "text",
"name": "deposit"
}
]
}
}
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.
Action to be performed
User address to get returns for
^0x[a-fA-F0-9]{40}$
Network to get returns for
Vault address to get returns for
^0x[a-fA-F0-9]{40}$
Simulate the transaction
false
Address of the asset to be used in the transaction
^0x[a-fA-F0-9]{40}$
Only applicable to deposit, redeem, request-redeem, Amount of the asset to be used in the transaction
Only applicable for redeem action. If true, all assets will be redeemed
Default Response
Default Response
Default Response
Default Response
Default Response
Default Response
GET /v2/transactions/{action}/{userAddress}/{network}/{vaultAddress} 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"
}
}
}
]
}
Last updated