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:

Find the addresses of the tokens you want to swap. For example, swapping WETH -> USDT
1. WETH: 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2
2. USDT: 0xdac17f958d2ee523a2206206994597c13d831ec7
Check for allowance of Arken Approve contract to spend source asset using /approve/allowance
If necessary, give approval for Arken Approve contract to spend the source token using /approve/transaction
Monitor the best exchange route using /swap/quote
When you are ready to swap, use /swap/swap to generate the call data to perform the swap

Chains

Health Check

Approve

Info

Swap

PreviousArken Price API NextArken Insider API

Last updated 1 year ago

Was this helpful?

Return supported chains list

get

/swap-engine/v1/chains

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://public-api.arken.finance/swap-engine/v1/chains'

200

{
  "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
      }
    ]
  ]
}

API health check

get

/swap-engine/v1/{chainID}/healthcheck

Authorizations

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://public-api.arken.finance/swap-engine/v1/{chainID}/healthcheck' \
  --header 'X-API-Username: YOUR_API_KEY'

200

No body

Always returns code 200 if API is stable

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

get

/swap-engine/v1/{chainID}/approve/spender

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://public-api.arken.finance/swap-engine/v1/{chainID}/approve/spender' \
  --header 'X-API-Username: YOUR_API_KEY'

200

400

500

{
  "address": "text"
}

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

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

get

/swap-engine/v1/{chainID}/approve/transaction

Authorizations

Query parameters

tokenAddressstringrequired

Token address you want to exchange

amountstring

The number of tokens that the Arken Approve is allowed to spend.If not specified, it will be allowed to spend an infinite amount of tokens.

Example: 100000000000

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://public-api.arken.finance/swap-engine/v1/{chainID}/approve/transaction?tokenAddress=text' \
  --header 'X-API-Username: YOUR_API_KEY'

200

400

500

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

Transaction body to allow the exchange with the Arken Approve

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

get

/swap-engine/v1/{chainID}/approve/allowance

Authorizations

Query parameters

tokenAddressstringrequired

Token address you want to exchange

walletAddressstringrequired

Wallet address for which you want to check

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://public-api.arken.finance/swap-engine/v1/{chainID}/approve/allowance?tokenAddress=text&walletAddress=text' \
  --header 'X-API-Username: YOUR_API_KEY'

200

400

500

{
  "amount": "text"
}

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

get

/swap-engine/v1/{chainID}/liquidity-sources

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://public-api.arken.finance/swap-engine/v1/{chainID}/liquidity-sources' \
  --header 'X-API-Username: YOUR_API_KEY'

200

400

500

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

All supported protocols public

Find the best quote to exchange via Arken Finance

get

/swap-engine/v1/{chainID}/swap/quote

Authorizations

Query parameters

fromTokenAddressstringrequired

Example: 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

toTokenAddressstringrequired

Example: 0xdac17f958d2ee523a2206206994597c13d831ec7

amountstringrequired

Example: 10000000000000000

gasPriceany

default: fast from network

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://public-api.arken.finance/swap-engine/v1/{chainID}/swap/quote?fromTokenAddress=text&toTokenAddress=text&amount=text' \
  --header 'X-API-Username: YOUR_API_KEY'

200

400

500

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

Quote

Generate data for calling the Arken Dex for exchange

get

/swap-engine/v1/{chainID}/swap/swap

Authorizations

Query parameters

fromTokenAddressstringrequired

Example: 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

toTokenAddressstringrequired

Example: 0xdac17f958d2ee523a2206206994597c13d831ec7

amountstringrequired

Example: 10000000000000000

fromAddressstringrequired

The address that calls the Arken Dex contract

slippagenumberrequired

min: 0; max: 50;

Example: 1

destReceiverstring

Receiver of destination currency. default: fromAddress

gasPricestring

default: fast from network

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://public-api.arken.finance/swap-engine/v1/{chainID}/swap/swap?fromTokenAddress=text&toTokenAddress=text&amount=text&fromAddress=text&slippage=1' \
  --header 'X-API-Username: YOUR_API_KEY'

200

400

500

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

Swap