Get swap quote

Quote a move between two accounts the user owns — USDC<->EURC on the Base wallet, or the wallet <-> a the banking provider USD virtual account. Every solver that can serve the route is compared and `allQuotes` ranks them; `executionContract` says how to execute the winner (docs/balance-swap.md).

POST /api/v1/balance/swap/quote

Get swap quote

cURL

curl --request POST \
  --url https://api.example.com/api/v1/balance/swap/quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "hevn",
  "to": "hevn",
  "amount": 1,
  "amountTo": 1,
  "swapType": "FLEX_INPUT",
  "providers": []
}
'

200

{
  "quoteId": "<string>",
  "fromAmount": 123,
  "fromCurrency": "<string>",
  "toAmount": 123,
  "toCurrency": "<string>",
  "feeAmount": 123,
  "feeCurrency": "<string>",
  "rate": 123,
  "minToAmount": 123,
  "slippageBps": 123,
  "fixedFee": 0,
  "flatFee": 0,
  "expiresAt": "2023-11-07T05:31:56Z",
  "provider": "<string>",
  "solver": "<string>",
  "estimated": false,
  "etaHours": 123,
  "allQuotes": []
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Body

application/json

Quote a move between two accounts the user owns (docs/balance-swap.md).

from/to name the accounts and default to the HEVN wallet, so the original token-swap payload (fromToken + toToken + amount) stays valid.

from · string<uuid> string · default: hevn

to · string<uuid> string · default: hevn

fromToken · enum<string> | null

Stablecoin a payout (offramp) quote is funded with.

USDC is the default across all providers. EURC is Align-only: Align accepts an EURC deposit for EUR/SEPA offramps (and prices other destination currencies through its own FX).

Available options: USDC, EURC

toToken · enum<string> | null

Stablecoin a payout (offramp) quote is funded with.

USDC is the default across all providers. EURC is Align-only: Align accepts an EURC deposit for EUR/SEPA offramps (and prices other destination currencies through its own FX).

Available options: USDC, EURC

amount · number | null

Required range: x > 0

amountTo · number | null

Required range: x > 0

swapType · enum<string> · default: FLEX_INPUT

Type of swap quote.

Available options: EXACT_INPUT, EXACT_OUTPUT, FLEX_INPUT, ANY_INPUT

providers · enum<string>[] | null

Cross-chain swap provider.

Available options: intents, lifi, align, cowswap, aerodrome

Response

200

application/json

Successful Response

A price for one move, and every solver that answered.

How to execute it is submit's answer, not this one: two copies of the contract would let a client sign the stale one.

quoteId · string · required

fromAmount · number · required

fromCurrency · string · required

toAmount · number · required

toCurrency · string · required

feeAmount · number · required

feeCurrency · string · required

rate · number · required

minToAmount · number | null

slippageBps · integer | null

fixedFee · number · default: 0

flatFee · number · default: 0

expiresAt · string<date-time> | null

provider · string | null

solver · string | null

estimated · boolean · default: false

etaHours · integer | null

allQuotes · SwapQuoteOption · object[]

Show child attributes