Github

GET /routeAndSwap (deprecated)

Note: this endpoint is deprecated, please use /route and /swap instead.

GET get best routes and generate swap transaction calldata to swap in Butter router

Request Parameters

Name
Location
Type
Required
Description

fromChainId

query

string

yes

source chain id, the supported chain ID list can be get from endpiont /supportedChainInfo

toChainId

query

string

yes

destination chain id

amount

query

string

yes

amount of source token

tokenInAddress

query

string

yes

address of source token, use 0x0000000000000000000000000000000000000000 for native token on most blockchains, T9yD14Nj9j7xAB4dbGeiX9h8unkKHxuWwb for native token on Tron

tokenOutAddress

query

string

yes

address of destination token

type

query

string

yes

swap type, one of "exactIn" and "exactOut"

slippage

query

string

yes

slippage of swap, a integer in range [0, 5000], e.g, 100 means 1%. For cross chain swap, the min slippage is 150， for cross chain from/to TON/BTC, min slippage is 300

from

query

string

yes

sender address on source chain

receiver

query

string

yes

receiver address on destination chain

entrance

query

string

yes

entrance of swap, please contact us for applying your dedicated entrance.

callData

query

string

no

encoded call data if receiver is a contract

caller

query

string

no

caller of butter router contract, e.g., the smart contract address who calls butter rotuer, or the user account who directly calls butter router

affiliate

query

string

no

affiliate nickname and fee rate, the format is '<nickname>[:rate]'. If fee rate is not provided, the default base rate (aka source rate) will be used, note that the rate could not be greater than max rate (aka target rate). E.g., for nickname 'butter' which has configured base rate to 0.1% and max rate to 1%, affiliate=butter means the affiliate charges 0.1% affiliate fee and affiliate=butter:50 means it charges 0.5% affiliate fee. For cross chain swap, you can specify multiple affiliates, but for same chain swap, at most one affilate can be accepted.

referrer

query

string

no

referrer address to receive the referrer(affiliate) fee in same chain swap. It is required for Solana same chain swap, and optional for EVM same chain swap. If not provided in EVM same chain swap, the default affiliate wallet will be used.

Request Example

Responses Structure

The response contains the following fields:

Field
Type
Description

errno

number

Error code. 0 means success, other values indicate errors, see error code list.

message

string

Response message. If the request was successful it is success, otherwise it gives corresponding error message.

data

array

Contains data on the swap route path, fees, etc.

data Field

The data field contains an array with one or more route and swap data. Each item has the following fields:

Field
Type
Description

route

object

The detailed route information, please refer to route API for details.

txParam

object

The swap transaction information, please refer to swap API for details.

Response Examples

  1. get best routes and swap transaction calldata successfully

200 Response

  1. fail to get route and/or swap transaction calldata

200 Response

Note: error code can be found in here

PreviousGET /swapNextGET /supportedChainList (deprecated)

Last updated