Skip to main content
Version: v2

TokensResponse

data object[]required

The page of tokens matching the query.

  • Array [
  • chainSelectorstringrequired

    The home chain selector for this token. Full chain metadata is available via the chains endpoint.

    Possible values: Value must match regular expression ^[0-9]+$

    Example: 5009297550715157269
    addressstringrequired

    On-chain token address on the home chain.

    symbolstringnullablerequired

    Token symbol.

    Example: USDC
    namestringnullablerequired

    Token name.

    Example: USD Coin
    decimalsintegernullablerequired

    Token decimals.

    Example: 6
    isReviewedbooleanrequired

    Whether Chainlink Labs has reviewed this token's project information.

    Example: true
    groupIdstringnullablerequired

    Persistent, opaque, stable id of the token group this token belongs to, if any.

    remoteChains object[]required

    The remote chains this token is configured toward (its lanes), one entry per remote chain. Always present. Collapsed, each entry carries only its selector; with expand=true each entry also carries status and remoteTokenAddress.

  • Array [
  • remoteChainSelectorstringrequired

    The remote (counterparty) chain selector for this lane.

    Possible values: Value must match regular expression ^[0-9]+$

    Example: 124615329519749607
    statusLaneConnectionStatus

    Connection status toward the remote chain. Present only when expand=true.

    Example: CONNECTED
    remoteTokenAddressstringnullable

    Address of the corresponding token on the remote chain. Present only when expand=true.

  • ]
  • ]
  • pagination objectrequired
    limitintegerrequired

    Number of tokens requested per page.

    Example: 50
    hasNextPagebooleanrequired

    Whether more tokens are available after this page.

    Example: true
    totalCountintegerrequired

    Exact number of tokens matching the query; never capped.

    Example: 42
    isCountCappedbooleanrequired

    Whether totalCount is capped.

    Example: false
    cursorstringnullable

    Pagination cursor for fetching the next page (pass as the cursor parameter).

    JSON
    TokensResponse
    {
    "data": [
    {
    "chainSelector": "5009297550715157269",
    "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eb48",
    "symbol": "USDC",
    "name": "USD Coin",
    "decimals": 6,
    "isReviewed": true,
    "groupId": "550e8400-e29b-41d4-a716-446655440000",
    "remoteChains": [
    {
    "remoteChainSelector": "124615329519749607"
    },
    {
    "remoteChainSelector": "4949039107694359620"
    }
    ]
    }
    ],
    "pagination": {
    "limit": 50,
    "hasNextPage": true,
    "totalCount": 42,
    "isCountCapped": false,
    "cursor": "WyJuYXR1cmFsIiwxMjM0NV0="
    }
    }