Get tokens

Query tokens

GET /insights/v1/tokens

Get tokens

cURL

curl --request GET \
  --url https://data-api.b3.fun/insights/v1/tokens

200

{
  "data": [
    {
      "chain_id": 1,
      "token_address": "vitalik.eth",
      "balance": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "decimals": 123,
      "price_data": {
        "price_usd": 123,
        "usd_value": 123,
        "volume_24h_usd": 123,
        "market_cap_usd": 123,
        "circulating_supply": 123,
        "total_supply": 123,
        "percent_change_24h": 123,
        "price_timestamp": "<string>"
      }
    }
  ]
}

Query Parameters

chain · number[]

Use chain_id instead

Example:

[20, 56, 1]

chain_id · number[]

The chain ID(s) to request the data for. You can specify multiple chain IDs, up to a maximum of 55. Use repeated query parameters, e.g., ?chain_id=20&chain_id=56. Optional, because a single chain can as well be specified as a subdomain

Example:

[20, 56, 1]

limit · integer · default: 20

The number of items to return

Required range: 0 < x <= 1000

Example:

20

page · integer | null · default: 0

Page number (0-indexed). Maximum value depends on query parameters: 20 for regular queries, 500 when using aggregate or group_by parameters.

Required range: x >= 0

Example:

0

metadata · enum<string> · default: false

Whether to include metadata for the tokens

Available options: true, false

Example:

"false"

resolve_metadata_links · enum<string> · default: true

Whether to resolve metadata IPFS or Arweave links

Available options: true, false

Example:

"false"

include_spam · enum<string> · default: false

Whether to include spam tokens

Available options: true, false

Example:

"false"

owner_address · string[] · required

Address(es) to filter by. You can specify multiple addresses using repeated query parameters, e.g., ?address=0x123&address=0x456

Example:

[
  "0x1234567890123456789012345678901234567890",
  "vitalik.eth"
]

include_native · enum<string> · default: true

Whether to include native tokens

Available options: true, false

Example:

"true"

token_address · string[]

Address(es) to filter by. You can specify multiple addresses using repeated query parameters, e.g., ?address=0x123&address=0x456

Example:

[
  "0x1234567890123456789012345678901234567890",
  "vitalik.eth"
]

sort_by · enum<string> · default: token_address

Field to sort by

Available options: balance, token_address, token_price, usd_value

Example:

"balance"

sort_order · enum<string> · default: asc

Sort order (asc or desc)

Available options: asc, desc

Example:

"desc"

include_without_price · enum<string> · default: true

Whether to include tokens that don't have price data (only applies when metadata=true)

Available options: true, false

Example:

"true"

Response

200

application/json

Successful response

data · object[] · required

Show child attributes