Sign in

v1

latestOpenAPI 3.0.02026-07-26278284.4 KB
Tokens

Tokens

Returns tokens and their details. <Tip>This APi includes cursor-based pagination with default 1000 items per page.</Tip>

get/api/v1/tokens

Query parameters

includeMetadataboolean

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

chainIdnumber
Example:1

Chain ID of the network of the token

projectstring
Example:aave

The overarching project or platform associated with the DeFi token, for example aave

protocolSlugstring
Example:aave-v2

The specific standard integration or version of the DeFi project, for example aave-v2

addressstring[]

Ethereum addresses of the tokens

[
  "0x030bA81f1c18d280636F32af80b9AAd02Cf0854e"
]
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"
]
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

type'defi' | 'base'
Example:defi

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

pagenumber

Pagination page number. Pages are of length 1000

cursornumber

Cursor for pagination. Pages are of length 1000

namestring[]

Names of the tokens

[
  "Bridged USDT"
]
symbolstring[]

Symbols of the tokens

[
  "USDC"
]
pageSizenumber
Example:100

Number of items per page (max 1000)

includeUnderlyingboolean

Whether to include underlying tokes

Response

Example response

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