Partner

Build the unsigned deposit batch for a stock + yield equity vault

post/v1/partner/equity/deposit/build

Request

  • Base URL: https://api.spiralstake.xyz
  • URL: https://api.spiralstake.xyz/v1/partner/equity/deposit/build
  • Auth: HTTP bearer

Request body

strategyIdstring required

The vault's id from /v1/strategies (starts with 'equity-').

amountstring required

Deposit in human units of the vault's deposit token (USDG), e.g. '10000'.

stockLtvPctstring

Stock-leg LTV percent. Default: the vault's targetLtvPct. Capped at 88% of the stock market's liquidation LTV; above it the request is refused.

slippagenumber

Ratio, default 0.01 (the app's equity setting), capped at 0.01.

chainId4663
userAddressstring required

Wallet that will sign; the stock leg and yield loop are opened for it.

Response

Unsigned call batch

chainIdinteger required
action'equity_deposit' | 'equity_exit' required
strategyIdstring required
atomictrue required

Changes

No recorded changes to this operation across all 1 revision of this API.