/v3/quote

POST

/v3/quote

Authorizations

• apiKey

Request Body ^required

object

sellAsset

required

Asset to sell

string

buyAsset

required

Asset to buy

string

sellAmount

required

string

providers

Array<string>

sourceAddress

Address to send asset from

string

destinationAddress

Address to send asset to

string

slippage

number

<= 100

cfBoost

Set to true to enable CF boost to speed up Chainflip swaps. BTC only.

boolean

referrer

string

disableEstimate

Set to true to disable on-chain estimation

boolean

default: true

maxExecutionTime

number

>= 1

affiliateFee

number

<= 1000

Responses

200

Default Response

object

quoteId

required

Quote ID

string

routes

required

Array<object>

object

sellAsset

required

Asset to sell

string

sellAmount

required

Sell amount

string

buyAsset

required

Asset to buy

string

buyAmount

Buy amount

string

buyAmountMaxSlippage

Buy amount max slippage

string

expectedBuyAmount

Expected Buy amount

string

expectedBuyAmountMaxSlippage

Expected Buy amount max slippage

string

fees

required

Array<object>

object

type

required

string

Allowed values: liquidity network inbound outbound affiliate service tax priority

amount

required

string

asset

required

string

chain

required

string

protocol

required

string

Allowed values: CHAINFLIP CHAINFLIP_STREAMING MAYACHAIN MAYACHAIN_STREAMING ONEINCH PANCAKESWAP PANGOLIN_V1 SUSHISWAP_V2 THORCHAIN THORCHAIN_STREAMING TRADERJOE_V2 UNISWAP_V2 UNISWAP_V3 CAVIAR_V1 JUPITER CAMELOT_V3 OCISWAP_V1 OPENOCEAN_V2 OKX NEAR GARDEN HARBOR

routeId

required

Route ID

string

providers

required

Array<string>

Allowed values: CHAINFLIP CHAINFLIP_STREAMING MAYACHAIN MAYACHAIN_STREAMING ONEINCH PANCAKESWAP PANGOLIN_V1 SUSHISWAP_V2 THORCHAIN THORCHAIN_STREAMING TRADERJOE_V2 UNISWAP_V2 UNISWAP_V3 CAVIAR_V1 JUPITER CAMELOT_V3 OCISWAP_V1 OPENOCEAN_V2 OKX NEAR GARDEN HARBOR

expiration

Expiration

string

estimatedTime

object

inbound

Time to receive inbound asset in seconds

number

swap

Time to swap assets in seconds

number

outbound

Time to receive outbound asset in seconds

number

total

required

Total time in seconds

number

totalSlippageBps

required

Total slippage in bps

number

legs

required

Array<object>

object

provider

required

string

Allowed values: CHAINFLIP CHAINFLIP_STREAMING MAYACHAIN MAYACHAIN_STREAMING ONEINCH PANCAKESWAP PANGOLIN_V1 SUSHISWAP_V2 THORCHAIN THORCHAIN_STREAMING TRADERJOE_V2 UNISWAP_V2 UNISWAP_V3 CAVIAR_V1 JUPITER CAMELOT_V3 OCISWAP_V1 OPENOCEAN_V2 OKX NEAR GARDEN HARBOR

sellAsset

required

Asset to sell

string

sellAmount

required

Sell amount

string

buyAsset

required

Asset to buy

string

buyAmount

Buy amount

string

buyAmountMaxSlippage

Buy amount max slippage

string

expectedBuyAmount

Expected Buy amount

string

expectedBuyAmountMaxSlippage

Expected Buy amount max slippage

string

fees

required

Array<object>

object

type

required

string

Allowed values: liquidity network inbound outbound affiliate service tax priority

amount

required

string

asset

required

string

chain

required

string

protocol

required

string

Allowed values: CHAINFLIP CHAINFLIP_STREAMING MAYACHAIN MAYACHAIN_STREAMING ONEINCH PANCAKESWAP PANGOLIN_V1 SUSHISWAP_V2 THORCHAIN THORCHAIN_STREAMING TRADERJOE_V2 UNISWAP_V2 UNISWAP_V3 CAVIAR_V1 JUPITER CAMELOT_V3 OCISWAP_V1 OPENOCEAN_V2 OKX NEAR GARDEN HARBOR

warnings

required

Array<object>

object

code

required

string

Allowed values: highSlippage highPriceImpact noSourceAddressToBuildTransaction affiliateFeeTooSmallSoRemoved unableToApplyReferralProgram insufficientBalance unableToBuildTransaction unableToEstimateGas

display

required

string

tooltip

string

meta

required

object

assets

Array<object>

object

asset

required

Asset name

string

price

required

Price in USD

number

image

required

Asset image

string

tags

required

Array<string>

Allowed values: CHEAPEST FASTEST RECOMMENDED

streamingInterval

number

maxStreamingQuantity

number

referrer

string

nextActions

Array<object>

object

method

required

string

url

required

string

payload

error

Error message

string

providerErrors

Array<object>

object

provider

string

Allowed values: CHAINFLIP CHAINFLIP_STREAMING MAYACHAIN MAYACHAIN_STREAMING ONEINCH PANCAKESWAP PANGOLIN_V1 SUSHISWAP_V2 THORCHAIN THORCHAIN_STREAMING TRADERJOE_V2 UNISWAP_V2 UNISWAP_V3 CAVIAR_V1 JUPITER CAMELOT_V3 OCISWAP_V1 OPENOCEAN_V2 OKX NEAR GARDEN HARBOR

errorCode

string

Allowed values: requestTimeout invalidApiVersion isSanctionedAddress unknownError test_error providerDetailsError blockHeaderNotFound blockHashNotFoundAtHeight blockHashNotFoundAtHash blackListAsset txHashMissing assetValueMissingInfo invalidAsset blockIsRequired currentBlockHeaderNotFound failedToRetrieveBalance failedToRetrieveBlock failedToRetrieveFees notImplementedBCH notImplementedDoge noPoolsFound noVaultsFound noTxFound noInputCoinFound noBlockDataFound multipleCosmosMessages heightOrHashNotProvided priceTooVolatile unknownDenom invalidBlockHeight timestampExtrinsicNoArgumentsForBlock timestampExtrinsicNoTimestampForBlock noTimestampExtrinsicForHash timestampExtrinsicNoArgumentsForHash txMemoUndefined txMemoIncorrect txTypeNotFound txNoMessage txNotFound txReceiptNotFound txParsingError txLogsParsingError txSaveTrackResultError txFailed jobDataParsingError blockNotFound balanceNotFound blockbookCallFailed configError synthSwapDisallowed providerQuoteTimeout noQuoteResponse noPoolAssetsFound noThorchainPools noMayachainPools noThorchainNetworkInfo invalidAffiliateFee invalidBuyAssetAddress invalidSellAssetAddress invalidSourceAddress invalidDestinationAddress invalidParam sourceAddressIsSmartContract destinationAddressIsSmartContract xrpAddressRequiresTag invalidChainId invalidChain unsupportedChainId unsupportedEVMChainId unsupportedMethod unsupportedProvider unsupportedProgram unsupportedEvent invalidParamsForMethod noWhitelistTokens failedFetchGasPrice chainflipBrokerApiUnavailable affiliateNotRegistered failedToCreateDepositChannel failedToRegisterAccount failedToRegisterAffiliate failedToWithdrawAffiliate noProviderDetailsFound noTokenListsFound tokenNotFound tokenPriceNotFound tokenPriceFailedToUpdate legsArrayIsEmpty failedToFetchQuoteForLeg noBlockHeaderFound failedToSimulateSwap swapHalted addressScreeningFailed missingScreeningConfig noLiquidtyProvidersFound insufficientLiquidity noSaversFound noInbounDataFound noInboundAddressesFound noInboundAddressFoundForChain noLastBlocksFound noVersionFound noConstantsFound noMimirsFound noRoutesFound quoteNotFound ledgerSignFailed ledgerWrongPayload ledgerFetchSwapFailed failedToFetchTx failedBuildTransactionDetails txBuildingTimeout noLegsForRoute insufficientBalance insufficientAllowance unableToBuildTransaction noRouterAddressFound noAggregatorAddressFound noContractInstanceFound noContractAddressFound invalidAffiliate invalidAffiliateName thornameNotFound thornameAffiliate No provider found No Record found Slippage too low tradingHalted mayanameNotFound noWrappedGasAsset aggregatorAddressNotFound routerAddressNotFound dummyAddressNotFound trackerError thorchainPoolUnavailable noOhlcvDataFound noTradingPairs missingState ledgerSwapNotFound ledgerSwapNotReadyForTracking ledgerInvalidParsingMode errorEstimatingGas apiKeyInvalid apiKeyFailedToUpdate apiKeyExpired unauthorized failedToCreateMemo radixIncorrectInstructions radixTxMissedParam radixTxMissedAccount radixManifestParseError radixManifestBuildError invalidAddressForChain riskyAddress noRoutesToProcess sellAssetAmountTooSmall sellAssetAmountTooLarge missingPrivateKey noMemoPriceProtection nodeMethodNotFound nodeRpcNotFound thirdPartyProviderNotFound quoteUnavailable targetInstructionNotFound referrerExist referrerNotFound invalidReferrer invalidReferralProgramAffiliate quoteLogicError missingDecimal noGasInfoInDB quoteError valueOverflow missingChainflipMeta contractAndMethodRequired tokenImageError fileNotFound fileFormatError ipError failedToSaveLedgerSwap missingValue missingDBQueryParam unableEstimateTxTime affiliateStatsMissingDate affiliateStatsMissingNextFilter affiliateStatsNoActions sdkError unsupportedNotificationEvent unsupportedNotificationChannel invalidWebhookUrl webhookDeliveryFailed serverStateNotFound apiRequestFailed apiRateLimit invalidActionStep providerIsRequired rateLimitExceeded depositChannelNotFound snowflakeFailedToFetchSwaps auditLogInsertFailed invalidRouteId invalidQuoteId invalidRoute quoteExpired swapQuoteNotFound swapRouteNotFound swapTransactionFailed swapChainflipMetaMissing swapChainflipChannelFailed swapTransferTxFailed zcashInvalidAddress zcashInsufficientUTXOs zcashUTXOSelectionFailed zcashTransactionBuildFailed invalidTokenProgram invalidRequest pubsubEventNotRegistered pubsubTopicNotFound invalidSpender outputAmountDeviationTooHigh

message

string

400

Default Response

object

message

required

string

error

required

string

data

500

Default Response

object

message

required

string

error

required

string

data