GET
/
api
/
v1
/
shortcuts
/
route
curl --request GET \
  --url https://api.enso.finance/api/v1/shortcuts/route \
  --header 'Authorization: Bearer <token>'
{
  "gas": "<string>",
  "amountOut": 123,
  "priceImpact": 123,
  "feeAmount": [
    "<string>"
  ],
  "createdAt": 123,
  "tx": {
    "data": "<string>",
    "to": "<string>",
    "from": "<string>",
    "value": "<string>"
  },
  "route": [
    {
      "tokenIn": [
        "<string>"
      ],
      "tokenOut": [
        "<string>"
      ],
      "protocol": "<string>",
      "action": "<string>",
      "primary": "<string>",
      "internalRoutes": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
chainId
number
default:1

Chain ID of the network to execute the transaction on

​
fromAddress
string
default:0xd8da6bf26964af9d7eed9e03e53415d37aa96045
required

Ethereum address of the wallet to send the transaction from

​
routingStrategy
enum<string> | null

Routing strategy to use

Available options:
router,
delegate,
ensowallet
​
toEoa
boolean | null
deprecated

Flag that indicates if gained tokenOut should be sent to EOA

​
receiver
string

Ethereum address of the receiver of the tokenOut

Example:

"0xd8da6bf26964af9d7eed9e03e53415d37aa96045"

​
spender
string

Ethereum address of the spender of the tokenIn

Example:

"0xd8da6bf26964af9d7eed9e03e53415d37aa96045"

​
amountIn
string[]
required

Amount of tokenIn to swap in wei

Example:
["1000000000000000000"]
​
minAmountOut
string[]

Minimum amount out in wei. If specified, slippage should not be specified

​
slippage
string
default:50

Slippage in basis points (1/10000). If specified, minAmountOut should not be specified

Example:

"300"

​
fee
string[]

Fee in basis points (1/10000) for each amountIn value. Must be in range 0-100. If specified, this percentage of each amountIn value will be sent to feeReceiver

Example:
["100"]
​
feeReceiver
string

The Ethereum address that will receive the collected fee. Required if fee is provided

Example:

"0x220866B1A2219f40e72f5c628B65D54268cA3A9D"

​
ignoreAggregators
string[] | null

A list of swap aggregators to be ignored from consideration

​
ignoreStandards
string[] | null

A list of standards to be ignored from consideration

​
tokenIn
string[]
required

Ethereum address of the token to swap from. For ETH, use 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

Example:
[
  "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee"
]
​
tokenOut
string[]
required

Ethereum address of the token to swap to. For ETH, use 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

Example:
[
  "0x6b175474e89094c44da98b954eedeac495271d0f"
]

Response

200
application/json
​
gas
string
required
​
amountOut
number
required

Quoted amount OUT of tokenOut, accounting for slippage

​
priceImpact
number
required

Price impact in basis points, null if USD price not found

​
feeAmount
string[]
required

An array of the fee amount collected for each tokenIn

​
createdAt
number
required

Block number the transaction was created on

​
tx
object
required

The tx object to use in ethers

​
route
object[]
required

The route the shortcut will use

Was this page helpful?