Sign in
Earn

Preview a direct vault deposit

Quotes how many shares a direct vault deposit would mint from the provider's live accounting. Use it when the strategy's depositSlippage.quoteRequired is true, then derive minSharesOut from sharesOut minus the chosen tolerance. Read-only, no idempotency key, and 501 when the provider cannot quote deposits.

post/v1/earn/vault-deposit-previews

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Request body

strategyIdstring required
amountstring required

Deposit amount in the vault token's units.

Example request

{
  "strategyId": "earn_strategy_example",
  "amount": "25"
}

Response

Live deposit quote

Example response

{
  "data": {
    "strategyId": "earn_strategy_example",
    "sharesOut": "24.98",
    "shareDecimals": 6,
    "blockingIssues": [
      {
        "code": "SHARE_LOCKED"
      }
    ]
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes

Changed in 1 of the 13 revisions of this API.1