Version: v2

TokenDetails

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.

pool objectnullablerequired

The single active home-chain token pool for this token, as recorded in the TokenAdminRegistry. null when no pool is registered.

addressstringrequired

Pool contract address on the home chain.

versionstringnullablerequired

Pool contract version.

Example: 1.6.0

typestringnullable

The pool's custody and transfer mechanism. null when the pool's contract type is not recognized.

Example: BURN_MINT

finality objectnullable

Pool finality configuration. Present only for pools running contract version 2.0+; null when the pool's finality has not been configured.

modestringrequired

How the pool waits for source-chain finality before honoring a transfer.

Example: blockDepth

blockDepthintegerrequired

Source-chain confirmation depth the pool waits for. Zero when the pool waits for finality.

Example: 12

safebooleanrequired

Whether the pool applies the chain's safe-block criterion.

Example: false

tokenAdminstringnullablerequired

TokenAdminRegistry administrator for this token and pool.

pendingTokenAdministratorstringnullablerequired

Address the TokenAdminRegistry administratorship is being transferred to. Set while an administrator transfer is in flight.

poolOwnerstringnullablerequired

Owner of the token pool contract.

pendingPoolOwnerstringnullablerequired

Address pool ownership is being transferred to. Set while an ownership transfer is in flight.

routerstringnullablerequired

Router contract the pool is wired to.

registryAddressstringnullablerequired

TokenAdminRegistry contract address.

hookstringnullable

Hook contract the pool invokes around transfers. Present only for pools running contract version 2.0+; null when none is configured.

ccv objectnullable

Pool-level cross-chain verifier settings. Present only for pools running contract version 2.0+; null when no threshold is configured.

thresholdAmountstringrequired

Transfer amount, in the token's base units, above which a lane's additional verifiers are required.

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

Example: 1000000000000000000000000

remoteChains object[]required

The active remote chains this token is configured toward (its lanes), one entry per remote chain, scoped to the active home pool.

Array [

remoteChainSelectorstringrequired

The remote (counterparty) chain selector for this lane.

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

Example: 124615329519749607

remoteTokenAddressstringnullablerequired

Address of the corresponding token on the remote chain.

statusLaneConnectionStatusrequired

Connection status of a token toward a remote chain (DISCONNECTED when the lane has been removed).

Example: CONNECTED

remotePoolsstring[]required

Remote pool address(es) the active home pool is configured toward for this chain.

rateLimits objectrequired

Inbound/outbound rate limits for one lane direction. fastInbound/fastOutbound are the fast-finality (FTF) per-lane limits.

inbound objectrequired

A token-bucket rate limiter.

isEnabledbooleanrequired

Whether the rate limiter is enforced.

capacitystringrequired

Maximum bucket capacity.

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

Example: 50000000000000000000000

ratestringrequired

Refill rate per second.

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

Example: 13880000000000000000

outbound objectrequired

A token-bucket rate limiter.

isEnabledbooleanrequired

Whether the rate limiter is enforced.

capacitystringrequired

Maximum bucket capacity.

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

Example: 50000000000000000000000

ratestringrequired

Refill rate per second.

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

Example: 13880000000000000000

fastInbound objectnullablerequired

Fast-finality (FTF) inbound rate limit.

isEnabledbooleanrequired

capacitystringrequired

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

ratestringrequired

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

fastOutbound objectnullablerequired

Fast-finality (FTF) outbound rate limit.

isEnabledbooleanrequired

capacitystringrequired

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

ratestringrequired

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

verifiers objectnullable

Per-direction verifier configuration for this lane. Present only for lanes on pools running contract version 2.0+; null when no verifiers are configured.

outbound objectrequired

Verifier (CCV) configuration for one lane direction.

requiredstring[]required

Verifier contracts that must verify every transfer in this direction.

additionalAboveThresholdstring[]required

Additional verifier contracts required when the transferred amount exceeds the pool's threshold amount.

inbound objectrequired

Verifier (CCV) configuration for one lane direction.

requiredstring[]required

Verifier contracts that must verify every transfer in this direction.

additionalAboveThresholdstring[]required

Additional verifier contracts required when the transferred amount exceeds the pool's threshold amount.

]

JSON

TokenDetails
{
  "chainSelector": "5009297550715157269",
  "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eb48",
  "symbol": "USDC",
  "name": "USD Coin",
  "decimals": 6,
  "isReviewed": true,
  "groupId": "550e8400-e29b-41d4-a716-446655440000",
  "pool": {
    "address": "0xc2949B1Cf2A739C5C53D43a3e7E5b8E5b5b1F3aF",
    "version": "2.0.0",
    "type": "BURN_MINT",
    "finality": {
      "mode": "blockDepth",
      "blockDepth": 12,
      "safe": false
    },
    "tokenAdmin": "0x44835bBBA9D40DEDa9b64858095EcFB2693c9449",
    "pendingTokenAdministrator": null,
    "poolOwner": "0x44835bBBA9D40DEDa9b64858095EcFB2693c9449",
    "pendingPoolOwner": null,
    "router": "0x80226fc0Ee2b096224EeAc085Bb9a8cba1146f7D",
    "registryAddress": "0xb22764f98dD05c789929716D677382Df22C05Cb6",
    "hook": "0xc305a03F29b9a7676159Abb8dCfCC899eb9aCc57",
    "ccv": {
      "thresholdAmount": "1000000000000000000000000"
    }
  },
  "remoteChains": [
    {
      "remoteChainSelector": "124615329519749607",
      "remoteTokenAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "status": "CONNECTED",
      "remotePools": [
        "0x0a995a72d8346683C97514990F802f4778b7Ac72"
      ],
      "rateLimits": {
        "outbound": {
          "isEnabled": true,
          "capacity": "50000000000000000000000",
          "rate": "13880000000000000000"
        },
        "inbound": {
          "isEnabled": true,
          "capacity": "50000000000000000000000",
          "rate": "13880000000000000000"
        },
        "fastOutbound": null,
        "fastInbound": null
      },
      "verifiers": {
        "outbound": {
          "required": [
            "0xb55BCa19C48074A7Fa693b8350785fd04034545a"
          ],
          "additionalAboveThreshold": []
        },
        "inbound": {
          "required": [
            "0xb55BCa19C48074A7Fa693b8350785fd04034545a"
          ],
          "additionalAboveThreshold": []
        }
      }
    },
    {
      "remoteChainSelector": "4949039107694359620",
      "remoteTokenAddress": "0x6B2a01A5f79dEb4c2f3c0eDa7b01DF456FbD726a",
      "status": "CONNECTED",
      "remotePools": [],
      "rateLimits": {
        "outbound": {
          "isEnabled": false,
          "capacity": "0",
          "rate": "0"
        },
        "inbound": {
          "isEnabled": false,
          "capacity": "0",
          "rate": "0"
        },
        "fastOutbound": null,
        "fastInbound": null
      }
    }
  ]
}