Skip to main content
GET
Get transaction payload

Authorizations

x-api-key
string
header
required

Path Parameters

action
enum<string>
required

Action to be performed

Available options:
deposit,
redeem,
request-redeem,
request-deposit,
claim-redeem,
claim-deposit,
claim-rewards,
start-redeem-cooldown
userAddress
string
required

User address to get returns for

Pattern: ^0x[a-fA-F0-9]{40}$
network
enum<string>
required

Network to get returns for

Available options:
mainnet,
optimism,
arbitrum,
polygon,
gnosis,
base,
unichain,
swellchain,
celo,
worldchain,
berachain,
ink,
bsc,
hyperliquid,
plasma,
avalanche,
katana,
linea,
mega-eth,
monad,
etherlink,
robinhood,
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,
eip155:4663
vaultId
string
required

Vault id to get returns for

Query Parameters

simulate
boolean
default:false

DEPRECATED: This parameter is deprecated and no longer functional

assetAddress
string
required

Address of the asset to be used in the transaction

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

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

all
boolean

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

Response

Default Response

currentActionIndex
number
required
actions
object[]
required