Skip to main content
POST
Get Swap Route

Path Parameters

workspaceId
string
required

Body

application/json
accountId
string
required

The account that will fund the swap

Example:

"w9jh0gf3w9qaxlre7enezt17"

fromAssetId
string
required

ID of the source asset

Example:

"2"

toAssetId
string
required

ID of the destination asset

Example:

"5002"

externalId
string

Client-side identifier of the quote request, reused as externalId when the transaction is created

Example:

"w2u573pjj5wl97p4v325z4a"

fromAmount
string<decimal>

Amount of the source asset. Exactly one of fromAmount or toAmount must be specified

Example:

"1.5"

fromTokenId
string

Token ID inside the source asset, required for NFT and Bron Lock assets

toAmount
string<decimal>

Amount of the destination asset. Exactly one of fromAmount or toAmount must be specified

Example:

"3.75"

toTokenId
string

Token ID inside the destination asset, required for NFT and Bron Lock assets

Response

OK

accountId
string
required
transactionType
enum<string>
required
Available options:
deposit,
withdrawal,
multi-withdrawal,
negative-deposit,
auto-withdrawal,
allowance,
defi,
defi-message,
address-activation,
address-creation,
stake-delegation,
stake-undelegation,
stake-claim,
stake-withdrawal,
stake-take-reward,
stake-earn-reward,
swap-lifi,
intents,
intent-solver-settlement,
loyalty-lock,
loyalty-unlock,
loyalty-collect-rewards,
canton-reward,
nft-deposit,
nft-withdrawal,
nft-allowance,
fiat-out,
fiat-in,
bridge,
earn-buy,
earn-sell,
power-bank-crypto-top-up,
power-bank-card-top-up,
power-bank-usage
description
string

The description of the transaction

Example:

"Withdrawal to an exchange"

embedded
object

Embedded related objects for this dry-run

estimations
object[]
externalId
string
extra
object
params
object
warning
object