API Specification

Parameters, input/output format
Basic GET API: https://router.firebird.finance/aggregator/v1/route?chainId=250&from=?&to=&receiver=&source=​
Curl sample
curl --location --request GET 'https://router.firebird.finance/aggregator/v1/route?chainId=250&from=0x04068da6c83afcfa0e13ba15a6696662335d5b75&to=0xf24bcf4d1e507740041c9cfd2dddb29585adce1e&amount=10000000&receiver=0x3FD5e7C6A2950691ffbf9358d0C093de30f54432&source=discord_swap_bot'
Request query parameters
get
URL:
 https://router.firebird.finance/aggregator/v1/route
Response payload
Field
Sub field
Type
Description
encodedData
​
json object
​
​
router
string
Firebird Router smart contract address
The address is returned here because it's frequently updated
​
data
string
Data encoded for given quote. Client just need to submit this data to given provided contract address returned at "router"
​
​
​
​
maxReturn
​
json object
​
​
from
string
ERC20 token contract address to sell
​
to
string
ERC20 token contract address to buy
​
totalFrom
string
buy amount of ERC20 tokens in wei
​
totalTo
numeric string
best sell amount of ERC20 tokens in wei
​
totalGas
number
​
​
gasPrice
numeric string
​
​
paths
array of object
swap paths, for display purpose
Example API Code
​https://github.com/firebird-prod/firebird_api_examples​
Integration example
const Web3 = require('web3')
const axios = require('axios')
​
const { BN } = Web3.utils
const MAX_UINT = '115792089237316195423570985008687907853269984665640564039457584007913129639935'
​
const PRIVATE_KEY = '' // TODO: config your private key
const ROUTER_API = 'https://router.firebird.finance/aggregator/v1/route'
const RPC_URL = 'https://rpc.ftm.tools/'
​
const ERC20_ABI = [
  {
    "constant": true,
    "inputs": [{ "name": "_owner", "type": "address" }, { "name": "_spender", "type": "address" }],
    "name": "allowance",
    "outputs": [{ "name": "remaining", "type": "uint256" }],
    "payable": false,
    "stateMutability": "view",
    "type": "function"
  },
  {
    "constant": false,
    "inputs": [{ "name": "_spender", "type": "address" }, { "name": "_value", "type": "uint256" }],
    "name": "approve",
    "outputs": [],
    "payable": false,
    "stateMutability": "nonpayable",
    "type": "function"
  }
]
​
const web3 = new Web3(new Web3.providers.HttpProvider(RPC_URL))
​
// PRIVATE_KEY variable defined
const account = web3.eth.accounts.privateKeyToAccount(PRIVATE_KEY)
​
function sendTransaction(tx) {
  const signPromise = web3.eth.accounts.signTransaction(tx, PRIVATE_KEY)
  return new Promise((resolve, reject) => {
    signPromise.then((signedTx) => {
      // raw transaction string may be available in .raw or
      // .rawTransaction depending on which signTransaction
      // function was called
      const sentTx = web3.eth.sendSignedTransaction(signedTx.raw || signedTx.rawTransaction)
      sentTx.on("receipt", receipt => {
        // do something when receipt comes back
        resolve(receipt)
      })
      sentTx.on("error", err => {
        // do something on transaction error
        reject(err)
      })
    }).catch((err) => {
      // do something when promise fails
      reject(err)
    })
  })
}
​
async function swap(params) {
  // fetch encoded swap transaction data
  const { data: { encodedData } } = await axios.get(ROUTER_API, {
    headers: { 'Content-Type': 'application/json' },
    params
  })
​
  const tokenIn = params.from
  const routerContract = encodedData.router // router contract address
  const currencyAIsEth = tokenIn.toLowerCase() === '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee'
  const amountIn = params.amount
​
  if (!currencyAIsEth) {
    // check approval
    const contract = new web3.eth.Contract(ERC20_ABI, tokenIn, {
      from: account.address
    })
    const allowance = await contract.methods.allowance(account.address, routerContract).call()
    if (new BN(allowance).lt(new BN(amountIn))) {
      console.log('# APPROVING...')
      const approvalData = contract.methods.approve(routerContract, MAX_UINT).encodeABI()
      const tx = {
        from: account.address,
        to: tokenIn,
        gas: '1000000',
        data: approvalData,
      }
      const approvalReceipt = await sendTransaction(tx, PRIVATE_KEY).catch()
      console.log('# APPROVED TXN:', approvalReceipt.transactionHash)
    }
  }
​
  const tx = {
    from: account.address, // signer address
    to: routerContract,
    gas: '1000000',
    data: encodedData.data, // encoded contract data
    value: currencyAIsEth ? amountIn : undefined,
  }
​
  console.log('# SWAPPING...')
  sendTransaction(tx)
    .then((receipt) => {
      console.log('# SWAP SUCCESSFULLY:')
      // do something when receipt comes back
      console.log(receipt)
    })
    .catch((err) => {
      console.log('# SWAP FAILED:')
      // do something on transaction error
      console.error(err)
    })
}
​
// swap USDC to FTM
swap({
  chainId: 250,
  from: '0x6c021ae822bea943b2e66552bde1d2696a53fbb7',
  to: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee',
  amount: '1000000',
  receiver: account.address,
  source: 'sample'
})
​

Developer - Previous

Overview

Next - Security

Contracts

Last modified 18d ago

Copy link

Outline

Parameters, input/output format

Request query parameters