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

GEThttps://public-api.arken.finance/insider/v1/chains

Response

200

Body

application/json

chainsarray of object

Request

JavaScriptCurlPython

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

Response

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

Health Check

API health check

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

Path parameters

chainID*string

Network ID of the blockchain you want to query.

Example: "42161"

Response

200

Always returns code 200 if API is stable

Request

JavaScriptCurlPython

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

Tokens

Information

Return current block number and timestamp of given chain

GEThttps://public-api.arken.finance/insider/v1/{chainID}/block

Path parameters

chainID*string

Network ID of the blockchain you want to query.

Example: "42161"

Response

200

Body

application/json

blockNumber*integer

Number of the current block.

Example: 75185607

blockTime*integer

Unix sec timestamp of the current block.

Example: 1680163667

updatedAt*string (date-time)

RFC3339 timestamp of the current block.

Example: "2023-03-30T15:07:47+07:00"

Pattern: ^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:(?:[0-5][0-9]|60)(?:\.[0-9]{1,15})?(?:Z|[+\-](?:[01][0-9]|2[0-3]):[0-5][0-9])$

Request

JavaScriptCurlPython

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

Response

200

{
  "blockNumber": 75185607,
  "blockTime": 1680163667,
  "updatedAt": "2023-03-30T15:07:47+07:00"
}

Return a list of tokens information from given token addresses

GEThttps://public-api.arken.finance/insider/v1/{chainID}/tokens

Path parameters

chainID*string

Network ID of the blockchain you want to query.

Example: "42161"

Query parameters

Response

200400500

a list of tokens information

Body

application/json

itemsany of

TokensGetInfoResponseDto (object)

Request

JavaScriptCurlPython

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

Response

200400500

[
  {
    "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

GEThttps://public-api.arken.finance/insider/v1/{chainID}/tokens/{address}

Path parameters

chainID*string

Network ID of the blockchain you want to query.

Example: "42161"

address*string

Token address you want to get information.

Example: "0x912ce59144191c1204e64559fe8253a0e49e6548"

Response

200400404500

Body

application/json

chain*string

blockchain network of token

Example: "ethereum"

address*string

contract address of token

Example: "0x912ce59144191c1204e64559fe8253a0e49e6548"

symbol*string

symbol of the token

Example: "ARB"

name*string

Example: "Arbitrum"

decimals*integer

number of decimals used to get its user representation

Example: 18

iconURLstring

image url of tokens

Example: "https://cdn.arken.finance/token/arbitrum/0x912ce59144191c1204e64559fe8253a0e49e6548"

Request

JavaScriptCurlPython

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

Response

200400404500

{
  "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.

GEThttps://public-api.arken.finance/insider/v1/{chainID}/tokens/stats

Path parameters

chainID*string

Network ID of the blockchain you want to query.

Example: "42161"

Query parameters

Response

200400500

Body

application/json

$addressobject

map(object) of token stats. key is token address

Request

JavaScriptCurlPython

const response = await fetch('https://public-api.arken.finance/insider/v1/{chainID}/tokens/stats?addresses=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "$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.

GEThttps://public-api.arken.finance/insider/v1/{chainID}/tokens/price/{address}

Path parameters

chainID*string

Network ID of the blockchain you want to query.

Example: "42161"

address*string

Token address you want to get price.

Example: "0x912ce59144191c1204e64559fe8253a0e49e6548"

Response

200400500

Body

application/json

price*number

Latest usd mid-price.

Example: 1.409363486

lastUpdatedAtinteger

Unix sec timestamp of the lastest price.

Example: 1680164258

lastUpdatedBlockinteger

Block number of the lastest price.

Example: 75188020

Request

JavaScriptCurlPython

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

Response

200400500

{
  "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.

GEThttps://public-api.arken.finance/insider/v1/{chainID}/tokens/price

Path parameters

chainID*string

Network ID of the blockchain you want to query.

Example: "42161"

Query parameters

Response

200400500

Body

application/json

$addressTokensGetPriceResponseDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://public-api.arken.finance/insider/v1/{chainID}/tokens/price?addresses=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "$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.

GEThttps://public-api.arken.finance/insider/v1/{chainID}/tokens/liquidity/{address}

Path parameters

chainID*string

Network ID of the blockchain you want to query.

Example: "42161"

address*string

Token address you want to get liquidity information.

Example: "0x912ce59144191c1204e64559fe8253a0e49e6548"

Response

200400404500

Body

application/json

chainstring

blockchain network of token

Example: "arbitrum"

addressstring

contract address of token

Example: "0x912ce59144191c1204e64559fe8253a0e49e6548"

priceUSDnumber

usd price from total liquidity calculation

Example: 1.378683846196434

totalTVLnumber

number of total assets(in $usd) that are currently staked in the liquidity pools of this token

Example: 118758830.19086324

totalBaseAmountnumber

number of total base tokens(given token address) that are currently staked in the liquidity pools of this token

Example: 34946760.58061671

poolsarray of any of

list of liquidity pools information

Request

JavaScriptCurlPython

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

Response

200400404500

{
  "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.

GEThttps://public-api.arken.finance/insider/v1/{chainID}/tokens/liquidity

Path parameters

chainID*string

Network ID of the blockchain you want to query.

Example: "42161"

Query parameters

Response

200400500

a list of tokens information

Body

application/json

itemsany of

TokensGetLiquidityResponseDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://public-api.arken.finance/insider/v1/{chainID}/tokens/liquidity?addresses=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

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