Arken Insider API

Arken Insider API contains a set of APIs about token price, 24-hour stats and token trading volume.

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

Please refer to Arken API for getting API tokens

Chains

Return supported chains list

get
Responses
200Success
application/json
get
GET /insider/v1/chains HTTP/1.1
Host: public-api.arken.finance
Accept: */*
200Success
{
  "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

get
Authorizations
Path parameters
chainIDstringRequired

Network ID of the blockchain you want to query.

Example: 42161
Responses
200

Always returns code 200 if API is stable

get
GET /insider/v1/{chainID}/healthcheck HTTP/1.1
Host: public-api.arken.finance
X-API-Username: YOUR_API_KEY
Accept: */*
200

Always returns code 200 if API is stable

No content

Tokens

Information

Return current block number and timestamp of given chain

get
Authorizations
Path parameters
chainIDstringRequired

Network ID of the blockchain you want to query.

Example: 42161
Responses
200Success
application/json
get
GET /insider/v1/{chainID}/block HTTP/1.1
Host: public-api.arken.finance
X-API-Username: YOUR_API_KEY
Accept: */*
200Success
{
  "blockNumber": 75185607,
  "blockTime": 1680163667,
  "updatedAt": "2023-03-30T15:07:47+07:00"
}

Return a list of tokens information from given token addresses

get
Authorizations
Path parameters
chainIDstringRequired

Network ID of the blockchain you want to query.

Example: 42161
Query parameters
addressesstringRequired

Alternatively pass one or more comma-separated token addresses.

Example: 0x912ce59144191c1204e64559fe8253a0e49e6548,0x82af49447d8a07e3bd95bd0d56f35241523fbab1
Responses
200

a list of tokens information

application/json
get
GET /insider/v1/{chainID}/tokens HTTP/1.1
Host: public-api.arken.finance
X-API-Username: YOUR_API_KEY
Accept: */*

[
  {
    "chain": "ethereum",
    "address": "0x912ce59144191c1204e64559fe8253a0e49e6548",
    "symbol": "ARB",
    "name": "Arbitrum",
    "decimals": 18,
    "iconURL": "https://cdn.arken.finance/token/arbitrum/0x912ce59144191c1204e64559fe8253a0e49e6548"
  }
]

Return an information of given token address

get
Authorizations
Path parameters
chainIDstringRequired

Network ID of the blockchain you want to query.

Example: 42161
addressstringRequired

Token address you want to get information.

Example: 0x912ce59144191c1204e64559fe8253a0e49e6548
Responses
200Success
application/json
get
GET /insider/v1/{chainID}/tokens/{address} HTTP/1.1
Host: public-api.arken.finance
X-API-Username: YOUR_API_KEY
Accept: */*

{
  "chain": "ethereum",
  "address": "0x912ce59144191c1204e64559fe8253a0e49e6548",
  "symbol": "ARB",
  "name": "Arbitrum",
  "decimals": 18,
  "iconURL": "https://cdn.arken.finance/token/arbitrum/0x912ce59144191c1204e64559fe8253a0e49e6548"
}

Stats 24 Hour

Returns price statistics for one or more cryptocurrencies. Stats are returned for an 24h period by default.

get
Authorizations
Path parameters
chainIDstringRequired

Network ID of the blockchain you want to query.

Example: 42161
Query parameters
addressesstringRequired

Alternatively pass one or more comma-separated token addresses.

Example: 0x912ce59144191c1204e64559fe8253a0e49e6548,0x82af49447d8a07e3bd95bd0d56f35241523fbab1
periodstringOptional

1h, 24h, 7d

Default: 24h
Responses
200Success
application/json
get
GET /insider/v1/{chainID}/tokens/stats HTTP/1.1
Host: public-api.arken.finance
X-API-Username: YOUR_API_KEY
Accept: */*

{
  "$address": {
    "open": 135.3000030517578,
    "close": 9908.99193585,
    "high": 20088.99609375,
    "low": 65.5260009765625,
    "change": -25.77168011860142,
    "volumeUSD": 74710.41730079339
  }
}

Price

Return a cryptocurrency mid-price($). Mid Price for each token is calculated based on the latest total liquidity of all supported dex in the network and quotation by $USD.

get
Authorizations
Path parameters
chainIDstringRequired

Network ID of the blockchain you want to query.

Example: 42161
addressstringRequired

Token address you want to get price.

Example: 0x912ce59144191c1204e64559fe8253a0e49e6548
Responses
200Success
application/json
get
GET /insider/v1/{chainID}/tokens/price/{address} HTTP/1.1
Host: public-api.arken.finance
X-API-Username: YOUR_API_KEY
Accept: */*

{
  "price": 1.409363486,
  "lastUpdatedAt": 1680164258,
  "lastUpdatedBlock": 75188020
}

Returns a map(object) of mid-prices($) for one or more cryptocurrencies in list. Mid Price for each token is calculated based on the latest total liquidity of all supported dex in the network and quotation by $USD.

get
Authorizations
Path parameters
chainIDstringRequired

Network ID of the blockchain you want to query.

Example: 42161
Query parameters
addressesstringRequired

Alternatively pass one or more comma-separated token addresses.

Example: 0x912ce59144191c1204e64559fe8253a0e49e6548,0x82af49447d8a07e3bd95bd0d56f35241523fbab1
Responses
200Success
application/json
get
GET /insider/v1/{chainID}/tokens/price HTTP/1.1
Host: public-api.arken.finance
X-API-Username: YOUR_API_KEY
Accept: */*

{
  "$address": {
    "price": 1.409363486,
    "lastUpdatedAt": 1680164258,
    "lastUpdatedBlock": 75188020
  }
}

Liquidity Information

Return an information of liquidity and TVL for a cryptocurrency. Information for each token is calculated based on the latest total liquidity of all supported dex in the network.

get
Authorizations
Path parameters
chainIDstringRequired

Network ID of the blockchain you want to query.

Example: 42161
addressstringRequired

Token address you want to get liquidity information.

Example: 0x912ce59144191c1204e64559fe8253a0e49e6548
Responses
200Success
application/json
get
GET /insider/v1/{chainID}/tokens/liquidity/{address} HTTP/1.1
Host: public-api.arken.finance
X-API-Username: YOUR_API_KEY
Accept: */*

{
  "chain": "arbitrum",
  "address": "0x912ce59144191c1204e64559fe8253a0e49e6548",
  "priceUSD": 1.378683846196434,
  "totalTVL": 118758830.19086324,
  "totalBaseAmount": 34946760.58061671,
  "pools": [
    {
      "chain": "arbitrum",
      "address": "0x92c63d0e701caae670c9415d91c474f686298f00",
      "dex": "univ3",
      "totalTVL": 35688599.624064386,
      "baseAddress": "0x912ce59144191c1204e64559fe8253a0e49e6548",
      "baseSymbol": "ARB",
      "baseAmount": 10873044.480467856,
      "basePrice": 1.379854509904129,
      "basePriceUSD": 16956.865795245092,
      "quoteAddress": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
      "quoteSymbol": "WETH",
      "quoteAmount": 11514.14796858391,
      "quotePrice": 1300.2001947035174,
      "quotePriceUSD": 1796.301994367361
    }
  ]
}

Return a list of information of liquidity and TVL for cryptocurrencies. Information for each token is calculated based on the latest total liquidity of all supported dex in the network.

get
Authorizations
Path parameters
chainIDstringRequired

Network ID of the blockchain you want to query.

Example: 42161
Query parameters
addressesstringRequired

Alternatively pass one or more comma-separated token addresses.

Example: 0x912ce59144191c1204e64559fe8253a0e49e6548,0x82af49447d8a07e3bd95bd0d56f35241523fbab1
Responses
200

a list of tokens information

application/json
get
GET /insider/v1/{chainID}/tokens/liquidity HTTP/1.1
Host: public-api.arken.finance
X-API-Username: YOUR_API_KEY
Accept: */*

[
  {
    "chain": "arbitrum",
    "address": "0x912ce59144191c1204e64559fe8253a0e49e6548",
    "priceUSD": 1.378683846196434,
    "totalTVL": 118758830.19086324,
    "totalBaseAmount": 34946760.58061671,
    "pools": [
      {
        "chain": "arbitrum",
        "address": "0x92c63d0e701caae670c9415d91c474f686298f00",
        "dex": "univ3",
        "totalTVL": 35688599.624064386,
        "baseAddress": "0x912ce59144191c1204e64559fe8253a0e49e6548",
        "baseSymbol": "ARB",
        "baseAmount": 10873044.480467856,
        "basePrice": 1.379854509904129,
        "basePriceUSD": 16956.865795245092,
        "quoteAddress": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
        "quoteSymbol": "WETH",
        "quoteAmount": 11514.14796858391,
        "quotePrice": 1300.2001947035174,
        "quotePriceUSD": 1796.301994367361
      }
    ]
  }
]
PreviousArken Swap Engine APINextArken Widgets

Last updated

Was this helpful?