Version: v2

TokenGroup

groupIdstringrequired

Persistent, opaque, stable id of the token group.

symbolstringnullablerequired

Canonical symbol of the group.

Example: USDC

displayNamestringnullablerequired

Display name of the group.

Example: USD Coin

logoUrlstringnullablerequired

Logo URL for the group.

Example: https://example.com/link-logo.png

isReviewedbooleanrequired

Whether Chainlink Labs has reviewed this token group's project information. Review is a per-group property; a token's isReviewed flag is inherited from its group.

Example: true

members object[]required

The tokens that belong to this group across networks.

Array [

chainSelectorstringrequired

The chain selector this group member lives on.

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

Example: 5009297550715157269

addressstringrequired

On-chain token address.

symbolstringnullablerequired

Token symbol.

Example: USDC

]

connections object[]required

Directed connections between members. Non-connected members have no edge; a bidirectional link appears as two edges.

Array [

sourceChainSelectorstringrequired

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

Example: 5009297550715157269

sourceTokenAddressstringrequired

Token address of the source member.

sourcePoolAddressstringrequired

Source token pool contract address for this route.

destChainSelectorstringrequired

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

Example: 124615329519749607

destTokenAddressstringrequired

Token address of the destination member.

remotePoolsstring[]required

Remote pool address(es) this source pool is configured toward for this route.

]

JSON

TokenGroup
{
  "groupId": "550e8400-e29b-41d4-a716-446655440000",
  "symbol": "USDC",
  "displayName": "USD Coin",
  "logoUrl": "https://example.com/link-logo.png",
  "isReviewed": true,
  "members": [
    {
      "chainSelector": "5009297550715157269",
      "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eb48",
      "symbol": "USDC"
    },
    {
      "chainSelector": "4949039107694359620",
      "address": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
      "symbol": "USDC"
    }
  ],
  "connections": [
    {
      "sourceChainSelector": "5009297550715157269",
      "sourceTokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eb48",
      "sourcePoolAddress": "0xc2949B1Cf2A739C5C53D43a3e7E5b8E5b5b1F3aF",
      "destChainSelector": "4949039107694359620",
      "destTokenAddress": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
      "remotePools": [
        "0x0a995a72d8346683C97514990F802f4778b7Ac72"
      ]
    },
    {
      "sourceChainSelector": "4949039107694359620",
      "sourceTokenAddress": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
      "sourcePoolAddress": "0x0a995a72d8346683C97514990F802f4778b7Ac72",
      "destChainSelector": "5009297550715157269",
      "destTokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eb48",
      "remotePools": [
        "0xc2949B1Cf2A739C5C53D43a3e7E5b8E5b5b1F3aF"
      ]
    }
  ]
}