Price a transfer between the client's own accounts

Compare every route that can serve this pair of accounts and return the best price. Nothing is booked with a provider and nothing is signed.

POST /swaps/preview

Price a transfer between the client's own accounts

cURL

curl --request POST \
  --url https://api.example.com/swaps/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "sourceAccount": "USDC",
  "destinationAccount": "USDC",
  "quote": {
    "fromAmount": "500.00",
    "fromCurrency": "<string>",
    "toAmount": "500.00",
    "toCurrency": "<string>",
    "rate": "500.00",
    "feeAmount": "500.00",
    "feeCurrency": "<string>",
    "minimumToAmount": "500.00",
    "estimated": false,
    "etaHours": 123,
    "expiresAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

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

Headers

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Body

application/json

sourceAccount · enum<string> · required

Account the money leaves.

Available options: USDC, EURC, FDIC_USD

destinationAccount · enum<string> · required

Account the money lands on.

Available options: USDC, EURC, FDIC_USD

amount · string | null

Exact amount to debit from the source account.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Example:

"500.00"

amountTo · string | null

Exact amount the destination account should receive.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Example:

"500.00"

Response

200

application/json

Successful Response

sourceAccount · enum<string> · required

Account the money would leave.

Available options: USDC, EURC, FDIC_USD

destinationAccount · enum<string> · required

Account the money would land on.

Available options: USDC, EURC, FDIC_USD

quote · SwapQuoteView · object · required

Best price available for this move right now.

Show child attributes