Partner

Build the unsigned open-leverage transaction

post/v1/partner/leverage/build

Request

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

Request body

strategyIdstring required

Morpho market id (from /v1/strategies).

payTokenstring required

Token to pay in. Collateral (direct) or any token (zapped). ETH = zero address.

amountstring required

Amount of payToken in human units, e.g. '10000'.

leveragenumber

Target leverage (e.g. 3). Provide this OR desiredLtv.

desiredLtvstring

Target LTV percent (e.g. '66.67'). Provide this OR leverage.

slippagenumber

Ratio, default 0.005, capped at 0.01.

chainId1 | 4663
userAddressstring required

Wallet that will sign; approvals + onBehalfOf are built for it.

Response

Unsigned tx bundle

chainIdinteger required
actionstring required
path'leverage' | 'swapAndLeverage' | 'reallocateAndLeverage' | 'reallocateSwapAndLeverage' | 'deleverage' | 'increaseLeverage' | 'supplyCollateral' | 'swapAndSupplyCollateral' | 'repay' | 'swapAndRepay' | 'withdrawCollateral' | 'borrow' required

Example response

{
  "action": "open_leverage",
  "meta": {
    "positionPreview": {
      "leverage": "3.0",
      "requestedLtv": "66.67",
      "effectiveLtv": "66.73",
      "expectedLeverageApy": "5.64",
      "priceImpactPct": "0.07",
      "swapSource": "KyberSwap"
    }
  }
}

Changes

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