CCIP API

The CCIP API provides information about supported chains and tokens in the Cross-Chain Interoperability Protocol (CCIP). This API allows you to query chain details, token information, supported fee tokens, and contract addresses needed for cross-chain operations.

Quick Start

Using Postman

We provide a complete Postman Collection that you can import to quickly test all API endpoints. The collection includes:

• All available endpoints with example requests
• Success and error test cases
• Environment variables for easy configuration

To import the collection into Postman:

1. Download the collection file from https://docs.chain.link/api/ccip/v1/postman-collection.json
2. Open Postman
3. Click "Import" in the top left corner
4. Drag and drop the downloaded file or click "Upload Files" to select it
5. Click "Import" to confirm

Before making requests:

1. In Postman, go to "Environments" and create a new environment
2. Add a variable named baseUrl with:
   • Initial value: https://docs.chain.link
   • Current value: http://localhost:4321 (for local testing) or https://docs.chain.link (for production)
3. Select your environment from the environment dropdown in the top right

Now you can start making requests to test the API endpoints!

Direct API Usage

# Chains API
# Get all mainnet chains
curl "https://docs.chain.link/api/ccip/v1/chains?environment=mainnet"

# Get Ethereum mainnet
curl "https://docs.chain.link/api/ccip/v1/chains?environment=mainnet&chainId=1"

# Get multiple chains by chainId
curl "https://docs.chain.link/api/ccip/v1/chains?environment=mainnet&chainId=1,56"

# Get multiple chains by internalId
curl "https://docs.chain.link/api/ccip/v1/chains?environment=mainnet&internalId=ethereum-mainnet,bsc-mainnet"

# Tokens API
# Get all mainnet tokens
curl "https://docs.chain.link/api/ccip/v1/tokens?environment=mainnet"

# Get tokens by symbol
curl "https://docs.chain.link/api/ccip/v1/tokens?environment=mainnet&symbol=LINK"

# Get tokens available on a specific chain
curl "https://docs.chain.link/api/ccip/v1/tokens?environment=mainnet&chainId=1"

API Reference

Endpoints

GET /api/ccip/v1/chains

Query CCIP chain information.

Query Parameters:

• environment (required): Network environment
  • Values: mainnet, testnet
• chainId (optional): Filter by chain ID
  • Single value: 1 (Ethereum)
  • Multiple values: 1,56 (Ethereum and BSC)
• selector (optional): Filter by CCIP chain selector
  • Single value: 5009297550715157269
  • Multiple values: 5009297550715157269,13264668187771770619
• internalId (optional): Filter by internal chain identifier
  • Single value: ethereum-mainnet
  • Multiple values: ethereum-mainnet,bsc-mainnet
• outputKey (optional): Key to use for response organization
  • Values: chainId, selector, internalId
  • Default: chainId

Response Format:

interface ChainApiResponse {
  metadata: {
    environment: string
    timestamp: string
    requestId: string
    ignoredChainCount: number
    validChainCount: number
  }
  data: {
    evm: Record<string, ChainDetails>
  }
  ignored: ChainConfigError[]
}

interface ChainDetails {
  chainId: number
  displayName: string
  selector: string
  internalId: string
  feeTokens: string[]
  router: string
  rmn: string
  registryModule: string
  tokenAdminRegistry: string
}

GET /api/ccip/v1/tokens

Query CCIP token information.

Query Parameters:

• environment (required): Network environment
  • Values: mainnet, testnet
• symbol (optional): Filter by token symbol
  • Single value: LINK (Chainlink)
  • Multiple values: LINK,ETH (Chainlink and Ethereum)
• chainId (optional): Filter by chain ID where the token is available
  • Single value: 1 (Ethereum)
  • Multiple values: 1,56 (Ethereum and BSC)
• outputKey (optional): Key to use for response organization
  • Values: chainId, selector, internalId
  • Default: chainId

Response Format:

interface TokenApiResponse {
  metadata: {
    environment: string
    timestamp: string
    requestId: string
    ignoredTokenCount: number
    validTokenCount: number
  }
  data: Record<string, TokenDetails>
  ignored: TokenConfigError[]
}

interface TokenDetails {
  symbol: string
  lanes: Record<string, string[]> // Source chain -> destination chains
  chains: TokenChainInfo[]
}

interface TokenChainInfo {
  chainId: number
  chainName: string
  tokenAddress: string
  decimals: number
  poolType: string
  poolAddress: string
}

Error Handling

The API uses standard HTTP status codes:

• 200: Success
• 400: Invalid request (e.g., invalid parameters)
• 500: Server error

Error responses follow this format:

interface ErrorResponse {
  error: string
  message: string
}

Development Tools

1. Postman Collection: Available at /api/ccip/v1/postman-collection.json
2. OpenAPI Spec: Available at /api/ccip/v1/openapi.json

Support

• Documentation: https://docs.chain.link/ccip
• Issues: https://github.com/smartcontractkit/chainlink/issues