Arken Swap Engine API

API Endpoint: https://public-api.arken.finance

Please refer to Arken API for getting API tokens

Using Arken Finance Swap Engine API, you can find the best route to exchange assets and make the swap. Here are the step-by-step instructions on how to use Arken Swap Engine API:

1. Find the addresses of the tokens you want to swap. For example, swapping WETH -> USDT

   1. WETH: 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2

   2. USDT: 0xdac17f958d2ee523a2206206994597c13d831ec7

2. Check for allowance of Arken Approve contract to spend source asset using /approve/allowance

3. If necessary, give approval for Arken Approve contract to spend the source token using /approve/transaction

4. Monitor the best exchange route using /swap/quote

5. When you are ready to swap, use /swap/swap to generate the call data to perform the swap

Chains

Return supported chains list

GEThttps://public-api.arken.finance/swap-engine/v1/chains

Response

200

Body

application/json

chainsarray of object

Request

JavaScriptCurl

const response = await fetch('https://public-api.arken.finance/swap-engine/v1/chains', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "chains": [
    [
      {
        "chainType": "ethereum",
        "chainID": 1
      },
      {
        "chainType": "arbitrum",
        "chainID": 42161
      },
      {
        "chainType": "bsc",
        "chainID": 56
      },
      {
        "chainType": "polygon",
        "chainID": 137
      },
      {
        "chainType": "avalanche",
        "chainID": 43114
      },
      {
        "chainType": "rei",
        "chainID": 55555
      }
    ]
  ]
}

Health Check

API health check

GEThttps://public-api.arken.finance/swap-engine/v1/{chainID}/healthcheck

Response

200

Always returns code 200 if API is stable

Request

JavaScriptCurl

const response = await fetch('https://public-api.arken.finance/swap-engine/v1/{chainID}/healthcheck', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Approve

Address of the Arken Approve that must be trusted to spend funds for the exchange

GEThttps://public-api.arken.finance/swap-engine/v1/{chainID}/approve/spender

Response

200400500

Address of the Arken Approve that must be trusted to spend funds for the exchange

Body

application/json

address*string

Address of the Arken Approve that must be trusted to spend funds for the exchange

Request

JavaScriptCurl

const response = await fetch('https://public-api.arken.finance/swap-engine/v1/{chainID}/approve/spender', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "address": "text"
}

Generate data for calling the contract in order to allow the Arken Approve to spend funds

GEThttps://public-api.arken.finance/swap-engine/v1/{chainID}/approve/transaction

Query parameters

Response

200400500

Transaction body to allow the exchange with the Arken Approve

Body

application/json

data*string

The encoded data to call the approve method on the swapped token contract

gasPrice*string

Gas price for fast transaction processing

to*string

Token address that will be allowed to exchange through Arken Approve

Example: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"

value*string

Native token value in WEI (for approve is always 0)

Request

JavaScriptCurl

const response = await fetch('https://public-api.arken.finance/swap-engine/v1/{chainID}/approve/transaction', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": "text",
  "gasPrice": "text",
  "to": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
  "value": "text"
}

Get the number of tokens that the Arken Approve is allowed to spend

GEThttps://public-api.arken.finance/swap-engine/v1/{chainID}/approve/allowance

Query parameters

Response

200400500

Body

application/json

amount*string

amount of tokens

Request

JavaScriptCurl

const response = await fetch('https://public-api.arken.finance/swap-engine/v1/{chainID}/approve/allowance', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "amount": "text"
}

Info

List of liquidity sources that are available for routing in the Arken Finance

GEThttps://public-api.arken.finance/swap-engine/v1/{chainID}/liquidity-sources

Response

200400500

All supported protocols public

Body

application/json

protocols*array of object

List of protocols that are available for routing in the Arken Finance

Request

JavaScriptCurl

const response = await fetch('https://public-api.arken.finance/swap-engine/v1/{chainID}/liquidity-sources', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "protocols": [
    {
      "id": "text",
      "title": "text",
      "imageURL": "text"
    }
  ]
}

Swap

Find the best quote to exchange via Arken Finance

GEThttps://public-api.arken.finance/swap-engine/v1/{chainID}/swap/quote

Query parameters

Response

200400500

Quote

Body

application/json

fromToken*TokenDto (object)

toToken*TokenDto (object)

toTokenAmount*string

Expected amount of destination token

fromTokenAmount*string

Amount of source token

protocols*array of PathViewDto (object)

Selected protocols in a path

estimatedGas*string

Request

JavaScriptCurl

const response = await fetch('https://public-api.arken.finance/swap-engine/v1/{chainID}/swap/quote', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "fromToken": {
    "symbol": "text",
    "name": "text",
    "address": "text",
    "decimals": 0,
    "logoURI": "text"
  },
  "toToken": {
    "symbol": "text",
    "name": "text",
    "address": "text",
    "decimals": 0,
    "logoURI": "text"
  },
  "toTokenAmount": "text",
  "fromTokenAmount": "text",
  "protocols": [
    {
      "id": "text",
      "title": "text",
      "part": 0,
      "fromTokenAddress": "text",
      "toTokenAddress": "text"
    }
  ],
  "estimatedGas": "text"
}

Generate data for calling the Arken Dex for exchange

GEThttps://public-api.arken.finance/swap-engine/v1/{chainID}/swap/swap

Query parameters

Response

200400500

Swap

Body

application/json

fromToken*TokenDto (object)

toToken*TokenDto (object)

toTokenAmount*string

Expected amount of destination token

fromTokenAmount*string

Amount of source token

protocols*array of string

Selected protocols in a path

tx*Tx (object)

Request

JavaScriptCurl

const response = await fetch('https://public-api.arken.finance/swap-engine/v1/{chainID}/swap/swap', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "fromToken": {
    "symbol": "text",
    "name": "text",
    "address": "text",
    "decimals": 0,
    "logoURI": "text"
  },
  "toToken": {
    "symbol": "text",
    "name": "text",
    "address": "text",
    "decimals": 0,
    "logoURI": "text"
  },
  "toTokenAmount": "text",
  "fromTokenAmount": "text",
  "protocols": [
    "text"
  ],
  "tx": {
    "from": "text",
    "to": "text",
    "data": "text",
    "value": "text",
    "gasPrice": "text",
    "gas": "text"
  }
}