Route Params
Route Params Page
Parameter name | Type | Description |
---|---|---|
amount * | string | amount of a token to sell,
for 1 Eth set as |
tokenInAddress * | string | contract address of a token to sell
e.g.: |
tokenOutAddress * | string | contract address of a token to buy e.g.: |
reverse | boolean | Default |
direct | boolean | Default |
excludeProtocols | [string] | The protocol ID |
excludeProtocols
: This is where you list the IDs of the AMMs you don't want to include. For example, if there are certain AMMs you prefer not to use due to high fees or other reasons, you simply put their unique IDs in this list.
supportPairs
: This function returns a list of supported AMMs, along with the AMM IDs.
Description of response parameters
Parameter name | Type | Description |
---|---|---|
success | boolean | It is a boolean value that serves as a status indicator for the API call. |
inputToken | Token | details of a token to sell |
inputAmount | string | details of a token to buy |
outputToken | Token | details of a token to buy |
route | [Route] | the best route for the swap |
time | number | execute time |
bestQuotesByProtocols | [string] | quotes from supported AMMs |
Last updated