Query a Swap

Query a swap from the API

Get a swap route from one token to another

GEThttps://router.nodefinance.org/routes

Path parameters

tokenIn*Address (string (20 byte EVM address))

Input token for swap

tokenOut*Address (string (20 byte EVM address))

Output token

amountIn*BigNumberString (string (Raw uint256 value))

Total amount of input token to be traded

fromAddress (string (20 byte EVM address))

Transaction originator. If present, will return a transaction ready to be signed

slippageinteger (BPS)

Allowed slippage, in bips. Can be congifigured at transaction, defaults to 10 BPS

toAddress (string (20 byte EVM address))

Recipient of trade. Defaults to from

deadlineMsUnixTime (integer (Unix Seconds))

Deadline for quote, defaults to 5 minutes

chainIdChainId (enum)

Chain to perform swap on, defaults to 42220 (CELO). More chains coming soon.

422204487

Response

200

Path found Successfully

Body

application/json

expectedOutBigNumberString (string (Raw uint256 value))

routerAddressAddress (string (20 byte EVM address))

detailsSwapPayload (object)

Request

JavaScriptCurl

const response = await fetch('https://router.nodefinance.org/routes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "expectedOut": "text",
  "routerAddress": "text",
  "details": {
    "path": [
      "text"
    ],
    "pairs": [
      "text"
    ],
    "extras": [
      "text"
    ],
    "inputAmount": "text",
    "expectedOutputAmount": "text",
    "sig": "text"
  }
}

Follow the above OpenAPI spec to query the routes endpoint, and receive a swap quote.

The return data will have the shape:

interface ReturnData {
    expectedOut: string,
    routerAddress: Address,
    details: {
        path: Address[],
        pairs: Address[],
        extras: string[],
        inputAmount: BigNumberString,
        expectedOutputAmount: BigNumberString,
        deadline: number,
        partner: number,
        sig: string
    }
}

type Address = string
type BigNumberString = string

Field	Description
expectedOut	Non decimal-adjusted output amount for the given trade. When displayed on a UI, you will have to account for decimals.
routerAddress	Address at the correct router implementation to perform the swap
details	Information necessary to perform the swap on chain. Some details, such as path, may be interesting to the end user. See Execute a Swap for a deeper breakdown of the details` object.