latestOpenAPI 3.0.02026-08-2232150173.9 KB

b70d36b7002b

metadata

Returns tokens and their details

get/api/v1/tokens

Query parameters

projectstring

Example:aave

The overarching project or platform associated with the DeFi token

protocolSlugstring

Example:aave-v2

The specific standard integration or version of the DeFi project

underlyingTokensstring[]

Underlying tokens of defi token

[
  "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
]

underlyingTokensExactstring[]

Exact composition of underlying tokens of defi token

[
  "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
]

primaryAddressstring[]

Ethereum addresses for contract interaction of defi tokens

[
  "0x7d2768dE32b0b80b7a3454c06BdAc94A69DDc7A9"
]

addressstring[]

Ethereum addresses of the tokens

[
  "0x030bA81f1c18d280636F32af80b9AAd02Cf0854e"
]

namestring[]

Names of the tokens

[
  "Bridged USDT"
]

symbolstring[]

Symbols of the tokens

[
  "USDC"
]

chainIdnumber

Example:1

Chain ID of the network of the token

type'defi' | 'base'

Example:defi

Type of token. If not provided, both types will be taken into account

liquidityType'SingleToken' | 'MultiToken'

Example:SingleToken

Type of liquidity. If not provided, both types will be taken into account

pagenumber

Pagination page number. Pages are of length 1000

pageSizenumber

Example:100

Number of items per page (max 1000)

cursornumber

Cursor for pagination. Pages are of length 1000

includeMetadataboolean

Whether to include token metadata (symbol, name and logos)

includeUnderlyingboolean

Whether to include underlying tokes

apyFromnumber

Example:1

Only include tokens with APY over this value

apyTonumber

Example:10

Only include tokens with APY below this value

tvlFromnumber

Only include tokens with TVL over this value

tvlTonumber

Example:10000000

Only include tokens with TVL below this value

Response

Example response

{
  "data": [
    {
      "project": "aave",
      "apy": 3.8,
      "apyBase": 2.6,
      "apyReward": 1.2,
      "borrowApyBase": 2.6,
      "borrowApyReward": 1.2,
      "tvl": 3001020.8
    }
  ]
}