diff --git a/astro.config.ts b/astro.config.ts index 576180d559a..4966f02d7f4 100644 --- a/astro.config.ts +++ b/astro.config.ts @@ -93,6 +93,11 @@ export default defineConfig({ return false } + // CCIP directory API v1 interactive page: noindex + omit from sitemap to avoid competing with CCIP Tools REST (v2) + if (cleanPath === "/api/ccip/v1/docs") { + return false + } + return !redirectSources.has(cleanPath) }, serialize(item) { diff --git a/postman/ccip-chains-api.json b/postman/ccip-chains-api.json index 83457f24a5f..a2754b99e85 100644 --- a/postman/ccip-chains-api.json +++ b/postman/ccip-chains-api.json @@ -1,7 +1,7 @@ { "info": { - "name": "CCIP API", - "description": "Collection for testing the Cross-Chain Interoperability Protocol (CCIP) API", + "name": "CCIP directory and configuration REST API (v1)", + "description": "**Deprecation:** CCIP Directory REST API (v1) is **planned for deprecation soon**; see https://docs.chain.link/ccip/tools/. For CCIP Tools REST API (v2), see https://docs.chain.link/ccip/tools/api/", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ diff --git a/public/api/ccip/v1/openapi.json b/public/api/ccip/v1/openapi.json index 4d3ec401d27..66f3ff76d7f 100644 --- a/public/api/ccip/v1/openapi.json +++ b/public/api/ccip/v1/openapi.json @@ -1,8 +1,8 @@ { "openapi": "3.0.0", "info": { - "title": "CCIP Docs config API", - "description": "API for retrieving CCIP chain, token, and lane information.\n\nTo get started quickly, you can download our [Postman Collection](/api/ccip/v1/postman-collection.json) which includes all endpoints and example requests.", + "title": "CCIP directory and configuration REST API (v1)", + "description": "**Deprecation:** This CCIP Directory and configuration REST API (v1), including `/api/ccip/v1/*` on docs.chain.link, is **planned for deprecation soon**. Timelines and migration guidance will be published in the [CCIP Tools documentation](https://docs.chain.link/ccip/tools/). For new integrations, prefer the [CCIP Tools REST API (v2)](https://docs.chain.link/ccip/tools/api/) where it meets your needs.\n\nREST API for CCIP supported chains, tokens, lanes, and related configuration on docs.chain.link. This is distinct from the CCIP Tools REST API (v2), which covers messages, lane latency, intents, and related tooling (https://docs.chain.link/ccip/tools/api/). For on-chain Solidity, Move, SVM, and TON interfaces, see https://docs.chain.link/ccip/api-reference.\n\nTo get started quickly, you can download our [Postman Collection](/api/ccip/v1/postman-collection.json) which includes all endpoints and example requests.", "version": "1.6.0", "contact": { "name": "File issues", diff --git a/public/api/ccip/v1/postman-collection.json b/public/api/ccip/v1/postman-collection.json index 0b69c452ad4..90214748fc3 100644 --- a/public/api/ccip/v1/postman-collection.json +++ b/public/api/ccip/v1/postman-collection.json @@ -1,7 +1,7 @@ { "info": { - "name": "CCIP API", - "description": "Collection for testing the Cross-Chain Interoperability Protocol (CCIP) API. Includes examples for chains, tokens, and lanes across EVM, Solana, and Aptos networks.", + "name": "CCIP directory and configuration REST API (v1)", + "description": "**Deprecation:** This CCIP Directory and configuration REST API (v1) is **planned for deprecation soon**; see https://docs.chain.link/ccip/tools/ for timelines and migration. Prefer CCIP Tools REST API (v2) for new work where applicable.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ diff --git a/public/ccip/llms.txt b/public/ccip/llms.txt index 0a017bc18fe..1af39f08394 100644 --- a/public/ccip/llms.txt +++ b/public/ccip/llms.txt @@ -49,10 +49,17 @@ Use directory pages only when retrieving current chain, lane, token, or contract ## Tools and Reference -- [EVM API Reference](https://docs.chain.link/ccip/api-reference.md) -- [SVM API Reference](https://docs.chain.link/ccip/api-reference/svm.md) -- [Aptos API Reference](https://docs.chain.link/ccip/api-reference/aptos.md) -- [TON API Reference](https://docs.chain.link/ccip/api-reference/ton.md) +On-chain contracts and interfaces: + +- [EVM contracts and interfaces reference](https://docs.chain.link/ccip/api-reference.md) +- [Solana program interfaces reference](https://docs.chain.link/ccip/api-reference/svm.md) +- [Aptos Move module interfaces reference](https://docs.chain.link/ccip/api-reference/aptos.md) +- [TON contract interfaces reference](https://docs.chain.link/ccip/api-reference/ton.md) + +### CCIP HTTP REST APIs + +- **Directory and configuration (v1)** — supported chains, tokens, and lanes: OpenAPI UI at `https://docs.chain.link/api/ccip/v1/docs` and spec at `https://docs.chain.link/api/ccip/v1/openapi.json`. **Planned for deprecation soon**; follow [CCIP Tools](https://docs.chain.link/ccip/tools/) for timelines and migration. Prefer [CCIP Tools API (v2)](https://docs.chain.link/ccip/tools/api/) for new work where applicable. +- **CCIP Tools (v2)** — messages, lane latency, intents: [CCIP Tools API](https://docs.chain.link/ccip/tools/api/). ## Live Data diff --git a/public/llms.txt b/public/llms.txt index d2ea44a81f0..c332e5e2f23 100644 --- a/public/llms.txt +++ b/public/llms.txt @@ -88,10 +88,10 @@ Operational Considerations - [Service Limits](https://docs.chain.link/ccip/service-limits.md) Reference -- [EVM API Reference](https://docs.chain.link/ccip/api-reference/evm.md) -- [SVM API Reference](https://docs.chain.link/ccip/api-reference/svm.md) -- [Aptos API Reference](https://docs.chain.link/ccip/api-reference/aptos.md) -- [TON API Reference](https://docs.chain.link/ccip/api-reference/ton.md) +- [EVM contracts and interfaces reference](https://docs.chain.link/ccip/api-reference/evm.md) +- [Solana program interfaces reference](https://docs.chain.link/ccip/api-reference/svm.md) +- [Aptos Move module interfaces reference](https://docs.chain.link/ccip/api-reference/aptos.md) +- [TON contract interfaces reference](https://docs.chain.link/ccip/api-reference/ton.md) ## Data Feeds diff --git a/src/content/ccip/api-reference/aptos/index.mdx b/src/content/ccip/api-reference/aptos/index.mdx index 60139d48955..d579247e784 100644 --- a/src/content/ccip/api-reference/aptos/index.mdx +++ b/src/content/ccip/api-reference/aptos/index.mdx @@ -1,9 +1,9 @@ --- section: ccip date: Last Modified -title: "Move Module Interfaces Reference Documentation (Aptos)" +title: "CCIP Move Module Interfaces Reference Documentation (Aptos)" metadata: - description: "Complete API reference documentation for Chainlink Cross-Chain Interoperability Protocol (CCIP) on the Aptos blockchain. Includes message structures, router functionality, events, and error handling." + description: "On-chain Move module interfaces for Chainlink CCIP on Aptos: messages, router, events, and errors." isIndex: true --- diff --git a/src/content/ccip/api-reference/evm/index.mdx b/src/content/ccip/api-reference/evm/index.mdx index 244d8d8ada7..68c7ffd18ac 100644 --- a/src/content/ccip/api-reference/evm/index.mdx +++ b/src/content/ccip/api-reference/evm/index.mdx @@ -1,9 +1,9 @@ --- section: ccip date: Last Modified -title: "Solidity Interfaces & Contracts Reference Documentation (EVM)" +title: "CCIP Solidity Interfaces & Contracts Reference Documentation (EVM)" metadata: - description: "Complete API reference documentation for Chainlink Cross-Chain Interoperability Protocol (CCIP) on EVM-based blockchains. Includes smart contracts, libraries, and interfaces for cross-chain messaging and token transfers." + description: "On-chain Solidity interfaces and contracts for Chainlink CCIP on EVM chains: routers, pools, receivers, and related contracts." isIndex: true --- diff --git a/src/content/ccip/api-reference/index.mdx b/src/content/ccip/api-reference/index.mdx index bd26148dba8..2d52189a119 100644 --- a/src/content/ccip/api-reference/index.mdx +++ b/src/content/ccip/api-reference/index.mdx @@ -1,14 +1,22 @@ --- section: ccip date: Last Modified -title: "CCIP API Reference" +title: "CCIP contracts and interfaces reference" metadata: - description: "Complete API reference documentation for Chainlink Cross-Chain Interoperability Protocol (CCIP). Access developer resources for EVM, Solana, and Aptos blockchains." + description: "On-chain reference for Chainlink CCIP: EVM, Solana, Aptos, and TON contracts and interfaces for cross-chain messaging and token transfers." isIndex: true --- Chainlink Cross-Chain Interoperability Protocol (CCIP) provides secure cross-chain messaging and token transfers between blockchain networks. -- **[EVM-based Blockchains](/ccip/api-reference/evm)**: Complete API reference for CCIP on Ethereum Virtual Machine (EVM) compatible blockchains. -- **[Solana](/ccip/api-reference/svm)**: Complete API reference for CCIP on Solana. -- **[Aptos Blockchain](/ccip/api-reference/aptos)**: Complete API reference for CCIP on the Aptos blockchain. +**This section is for on-chain integration** (contracts, interfaces, and program modules). CCIP also exposes HTTP APIs for different jobs: + +- **Directory and configuration REST API (v1)** — JSON for supported chains, tokens, and lanes served from `docs.chain.link`. **Planned for deprecation soon**; timelines and migration steps will be published with the [CCIP Tools documentation](https://docs.chain.link/ccip/tools/). Until then: interactive reference [/api/ccip/v1/docs](/api/ccip/v1/docs); machine-readable spec [/api/ccip/v1/openapi.json](/api/ccip/v1/openapi.json). Prefer the [CCIP Tools REST API (v2)](https://docs.chain.link/ccip/tools/api/) for new integrations where it meets your needs. +- **CCIP Tools REST API (v2)** — messages, lane latency, intents, and related tooling. See the [CCIP Tools API documentation](https://docs.chain.link/ccip/tools/api/) and [CCIP Tools overview](https://docs.chain.link/ccip/tools/). + +Platform-specific **contracts and interfaces** on this site: + +- **[EVM-based blockchains](/ccip/api-reference/evm)**: Solidity interfaces and contracts for CCIP on Ethereum Virtual Machine (EVM) compatible chains. +- **[Solana](/ccip/api-reference/svm)**: SVM program interfaces for CCIP on Solana. +- **[Aptos](/ccip/api-reference/aptos)**: Move module interfaces for CCIP on Aptos. +- **[TON](/ccip/api-reference/ton)**: TON contract interfaces for CCIP on TON. diff --git a/src/content/ccip/api-reference/svm/index.mdx b/src/content/ccip/api-reference/svm/index.mdx index a2654214c9b..9d544e30c27 100644 --- a/src/content/ccip/api-reference/svm/index.mdx +++ b/src/content/ccip/api-reference/svm/index.mdx @@ -1,9 +1,9 @@ --- section: ccip date: Last Modified -title: "SVM Program Interfaces Reference Documentation (SVM)" +title: "CCIP Program Interfaces Reference Documentation (Solana)" metadata: - description: "Complete API reference documentation for Chainlink CCIP on Solana. Includes message structures, router functionality, events, and error handling." + description: "Onchain SVM program interfaces for Chainlink CCIP on Solana: message structures, router, pools, events, and errors." isIndex: true --- diff --git a/src/content/ccip/api-reference/ton/index.mdx b/src/content/ccip/api-reference/ton/index.mdx index 3695c15b2d5..2693b14a8be 100644 --- a/src/content/ccip/api-reference/ton/index.mdx +++ b/src/content/ccip/api-reference/ton/index.mdx @@ -1,9 +1,9 @@ --- section: ccip date: Last Modified -title: "TON Contract Interface Reference Documentation" +title: "CCIP Contract Interface Reference Documentation (TON)" metadata: - description: "Complete API reference documentation for Chainlink CCIP on the TON blockchain. Includes message structures, router interface, receiver interface, events, and error codes." + description: "Onchain TON contract interfaces for Chainlink CCIP: messages, router, receiver, events, and error codes." isIndex: true --- diff --git a/src/content/ccip/llms-full.txt b/src/content/ccip/llms-full.txt index d3117ebc07b..1d47669eda1 100644 --- a/src/content/ccip/llms-full.txt +++ b/src/content/ccip/llms-full.txt @@ -7375,13 +7375,13 @@ Locate the CCIP-BnM contract address in the [CCIP Directory](/ccip/directory/tes --- -# CCIP API, SDK & CLI +# CCIP Tools API, SDK & CLI Source: https://docs.chain.link/ccip/tutorials/offchain Last Updated: 2026-03-02 Chainlink CCIP provides three tools for interacting with CCIP programmatically: -- **[CCIP API](https://docs.chain.link/ccip/tools/api/)**: REST API with endpoints for querying messages and their details, lane latency, and intents. +- **[CCIP Tools REST API (v2)](https://docs.chain.link/ccip/tools/api/)**: REST API with endpoints for querying messages and their details, lane latency, and intents. - **[CCIP SDK](https://docs.chain.link/ccip/tools/sdk/)** ([`@chainlink/ccip-sdk`](https://www.npmjs.com/package/@chainlink/ccip-sdk)): A TypeScript library for sending messages, transferring tokens, estimating fees, and querying CCIP activity. - **[CCIP CLI](https://docs.chain.link/ccip/tools/cli/)** ([`@chainlink/ccip-cli`](https://www.npmjs.com/package/@chainlink/ccip-cli)): A command-line interface built on top of the SDK. @@ -26710,7 +26710,7 @@ Once testing is complete, please share your CCIP transaction hashes with the tea --- -# Solidity Interfaces & Contracts Reference Documentation (EVM) +# CCIP Solidity Interfaces & Contracts Reference Documentation (EVM) Source: https://docs.chain.link/ccip/api-reference/evm ## Available Versions @@ -48853,7 +48853,7 @@ These events are emitted when a cross-chain message is executed on the destinati --- -# SVM Program Interfaces Reference Documentation (SVM) +# CCIP Program Interfaces Reference Documentation (Solana) Source: https://docs.chain.link/ccip/api-reference/svm ## Available Versions @@ -52196,7 +52196,7 @@ pub struct ExecutionStateChanged { --- -# Move Module Interfaces Reference Documentation (Aptos) +# CCIP Move Module Interfaces Reference Documentation (Aptos) Source: https://docs.chain.link/ccip/api-reference/aptos ## Available Versions @@ -52844,7 +52844,7 @@ struct ExecutionStateChanged has store, drop { --- -# TON Contract Interface Reference Documentation +# CCIP Contract Interface Reference Documentation (TON) Source: https://docs.chain.link/ccip/api-reference/ton @@ -67542,14 +67542,22 @@ function supportsInterface(bytes4 interfaceId) public pure virtual override retu --- -# CCIP API Reference +# CCIP contracts and interfaces reference Source: https://docs.chain.link/ccip/api-reference Chainlink Cross-Chain Interoperability Protocol (CCIP) provides secure cross-chain messaging and token transfers between blockchain networks. -- **[EVM-based Blockchains](/ccip/api-reference/evm)**: Complete API reference for CCIP on Ethereum Virtual Machine (EVM) compatible blockchains. -- **[Solana](/ccip/api-reference/svm)**: Complete API reference for CCIP on Solana. -- **[Aptos Blockchain](/ccip/api-reference/aptos)**: Complete API reference for CCIP on the Aptos blockchain. +**This section is for on-chain integration** (contracts, interfaces, and program modules). CCIP also exposes HTTP APIs for different jobs: + +- **Directory and configuration REST API (v1)** — JSON for supported chains, tokens, and lanes served from `docs.chain.link`. **Planned for deprecation soon**; timelines and migration steps will be published with the [CCIP Tools documentation](https://docs.chain.link/ccip/tools/). Until then: interactive reference [/api/ccip/v1/docs](/api/ccip/v1/docs); machine-readable spec [/api/ccip/v1/openapi.json](/api/ccip/v1/openapi.json). Prefer the [CCIP Tools REST API (v2)](https://docs.chain.link/ccip/tools/api/) for new integrations where it meets your needs. +- **CCIP Tools REST API (v2)** — messages, lane latency, intents, and related tooling. See the [CCIP Tools API documentation](https://docs.chain.link/ccip/tools/api/) and [CCIP Tools overview](https://docs.chain.link/ccip/tools/). + +Platform-specific **contracts and interfaces** on this site: + +- **[EVM-based blockchains](/ccip/api-reference/evm)**: Solidity interfaces and contracts for CCIP on Ethereum Virtual Machine (EVM) compatible chains. +- **[Solana](/ccip/api-reference/svm)**: SVM program interfaces for CCIP on Solana. +- **[Aptos](/ccip/api-reference/aptos)**: Move module interfaces for CCIP on Aptos. +- **[TON](/ccip/api-reference/ton)**: TON contract interfaces for CCIP on TON. --- diff --git a/src/content/ccip/llms.txt b/src/content/ccip/llms.txt index 0a017bc18fe..7b440c30fcd 100644 --- a/src/content/ccip/llms.txt +++ b/src/content/ccip/llms.txt @@ -12,7 +12,7 @@ Use directory pages only when retrieving current chain, lane, token, or contract - [Getting Started](https://docs.chain.link/ccip/getting-started.md) - [Getting Started (EVM)](https://docs.chain.link/ccip/getting-started/evm.md) - [Getting Started (Aptos)](https://docs.chain.link/ccip/getting-started/aptos.md) -- [Getting Started (SVM)](https://docs.chain.link/ccip/getting-started/svm.md) +- [Getting Started (Solana)](https://docs.chain.link/ccip/getting-started/svm.md) ## Concepts and Architecture @@ -49,10 +49,17 @@ Use directory pages only when retrieving current chain, lane, token, or contract ## Tools and Reference -- [EVM API Reference](https://docs.chain.link/ccip/api-reference.md) -- [SVM API Reference](https://docs.chain.link/ccip/api-reference/svm.md) -- [Aptos API Reference](https://docs.chain.link/ccip/api-reference/aptos.md) -- [TON API Reference](https://docs.chain.link/ccip/api-reference/ton.md) +On-chain contracts and interfaces: + +- [EVM contracts and interfaces reference](https://docs.chain.link/ccip/api-reference.md) +- [SVM program interfaces reference](https://docs.chain.link/ccip/api-reference/svm.md) +- [Aptos Move module interfaces reference](https://docs.chain.link/ccip/api-reference/aptos.md) +- [TON contract interfaces reference](https://docs.chain.link/ccip/api-reference/ton.md) + +### CCIP HTTP REST APIs + +- **Directory and configuration (v1)** — supported chains, tokens, and lanes: OpenAPI UI at `https://docs.chain.link/api/ccip/v1/docs` and spec at `https://docs.chain.link/api/ccip/v1/openapi.json`. **Planned for deprecation soon**; follow [CCIP Tools](https://docs.chain.link/ccip/tools/) for timelines and migration. Prefer [CCIP Tools API (v2)](https://docs.chain.link/ccip/tools/api/) for new work where applicable. +- **CCIP Tools (v2)** — messages, lane latency, intents: [CCIP Tools API](https://docs.chain.link/ccip/tools/api/). ## Live Data diff --git a/src/content/ccip/tutorials/offchain/index.mdx b/src/content/ccip/tutorials/offchain/index.mdx index c3d919c2fd4..62be50eb5c2 100644 --- a/src/content/ccip/tutorials/offchain/index.mdx +++ b/src/content/ccip/tutorials/offchain/index.mdx @@ -1,9 +1,9 @@ --- section: ccip date: Last Modified -title: "CCIP API, SDK & CLI" +title: "CCIP Tools API, SDK & CLI" metadata: - description: "REST API, TypeScript SDK, and CLI for interacting with Chainlink CCIP. Query messages, send transfers, estimate fees, and inspect lane configurations." + description: "CCIP Tools REST API (v2), TypeScript SDK, and CLI for Chainlink CCIP. Query messages, send transfers, estimate fees, and inspect activity." excerpt: "CCIP API, CCIP SDK, CCIP CLI, TypeScript, cross-chain messaging, token transfers, gas estimation, REST API" datePublished: "2026-02-19" lastModified: "2026-03-02" @@ -11,7 +11,7 @@ metadata: Chainlink CCIP provides three tools for interacting with CCIP programmatically: -- **[CCIP API](https://docs.chain.link/ccip/tools/api/)**: REST API with endpoints for querying messages and their details, lane latency, and intents. +- **[CCIP Tools REST API (v2)](https://docs.chain.link/ccip/tools/api/)**: REST API with endpoints for querying messages and their details, lane latency, and intents. - **[CCIP SDK](https://docs.chain.link/ccip/tools/sdk/)** ([`@chainlink/ccip-sdk`](https://www.npmjs.com/package/@chainlink/ccip-sdk)): A TypeScript library for sending messages, transferring tokens, estimating fees, and querying CCIP activity. - **[CCIP CLI](https://docs.chain.link/ccip/tools/cli/)** ([`@chainlink/ccip-cli`](https://www.npmjs.com/package/@chainlink/ccip-cli)): A command-line interface built on top of the SDK. diff --git a/src/pages/api/ccip/README.md b/src/pages/api/ccip/README.md index d58fd28173c..34fbbe7172c 100644 --- a/src/pages/api/ccip/README.md +++ b/src/pages/api/ccip/README.md @@ -1,6 +1,21 @@ -# CCIP API +# CCIP directory and configuration REST API (v1) -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. +This folder documents the **CCIP directory REST API** hosted on Chainlink Documentation (`/api/ccip/v1/*`): supported chains, tokens, and lanes. + +## Deprecation + +The **CCIP Directory and configuration REST API (v1)** (`/api/ccip/v1/*` on docs.chain.link) is **planned for deprecation soon**. Official timelines and migration guidance will be published in the [CCIP Tools documentation](https://docs.chain.link/ccip/tools/). For new integrations, prefer the [CCIP Tools REST API (v2)](https://docs.chain.link/ccip/tools/api/) and the SDK/CLI where they cover your use case. + +## Related documentation (different products) + +| Surface | Use when you need | Where | +| ------------------------------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| **CCIP Tools REST API (v2)** | Messages, lane latency, intents, tooling | [CCIP Tools API](https://docs.chain.link/ccip/tools/api/) (maintained with the CCIP Tools docs site) | +| **On-chain contracts and interfaces** | Solidity, Move, SVM, TON integration | [CCIP contracts and interfaces reference](https://docs.chain.link/ccip/api-reference) | + +The CCIP Tools docs repository should cross-link back here for directory/configuration (v1) and keep page titles distinct (e.g. include "Tools" and "v2" in REST API page metadata) so search engines do not merge intents with this v1 surface. + +This HTTP API returns information about supported chains and tokens in CCIP. You can query chain details, token information, supported fee tokens, and contract addresses used for cross-chain operations. ## Quick Start diff --git a/src/pages/api/ccip/v1/docs.astro b/src/pages/api/ccip/v1/docs.astro index 4ca6e697ae2..f365a370e5b 100644 --- a/src/pages/api/ccip/v1/docs.astro +++ b/src/pages/api/ccip/v1/docs.astro @@ -67,25 +67,26 @@ Astro.response.headers.set("Cache-Control", "s-max-age=300, stale-while-revalida - CCIP API Documentation + CCIP directory and configuration REST API (v1) | Chainlink Documentation + - + @@ -93,8 +94,11 @@ Astro.response.headers.set("Cache-Control", "s-max-age=300, stale-while-revalida - - + + @@ -109,8 +113,8 @@ Astro.response.headers.set("Cache-Control", "s-max-age=300, stale-while-revalida { "@context": "https://schema.org", "@type": "TechArticle", - "headline": "CCIP Configuration API Documentation", - "description": "Documentation for the Chainlink CCIP Configuration API", + "headline": "CCIP directory and configuration REST API (v1)", + "description": "Deprecation: CCIP Directory and configuration REST API (v1) is planned for deprecation soon. OpenAPI docs for chains, tokens, and lanes; use CCIP Tools REST API (v2) for messages and intents.", "author": { "@type": "Organization", "name": "Chainlink" @@ -128,11 +132,52 @@ Astro.response.headers.set("Cache-Control", "s-max-age=300, stale-while-revalida "@id": "https://docs.chain.link/api/ccip/v1/docs" }, "datePublished": "2025-03-06T00:00:00+00:00", - "dateModified": "2025-03-06T00:00:00+00:00" + "dateModified": "2026-05-13T00:00:00+00:00" } + + +
+
+

+ CCIP Tools REST API (v2): for messages, lane latency, and intents, see the + CCIP Tools API documentation. + On-chain contracts: see the + CCIP contracts and interfaces reference. +

+
+
+
-

CCIP API Documentation v1

+

CCIP directory and configuration REST API v1

- The Cross-Chain Interoperability Protocol (CCIP) API provides comprehensive information about supported - blockchain networks, tokens, and their configurations across multiple blockchain families including EVM, - Solana, and Aptos. + This HTTP API returns supported blockchain networks, tokens, lanes, and related configuration for CCIP across + EVM, Solana, and Aptos. It is planned for deprecation soon (see the notice above). The CCIP Tools + REST API (v2) covers execution-time data such as messages and intents and is the preferred surface for new work + where applicable.

-

API Overview

-

This documentation provides details about:

+

API overview

+

This reference describes:

  • Available endpoints for retrieving chain and token information
  • Chain details including IDs, selectors, and contract addresses
    • diff --git a/src/tests/openapi.test.ts b/src/tests/openapi.test.ts index 4b4ba9dff20..13442141bb2 100644 --- a/src/tests/openapi.test.ts +++ b/src/tests/openapi.test.ts @@ -19,7 +19,7 @@ describe("OpenAPI Specification", () => { it("should have required info fields", () => { expect(openApiDoc.info).toBeDefined() - expect(openApiDoc.info.title).toBe("CCIP Docs config API") + expect(openApiDoc.info.title).toBe("CCIP directory and configuration REST API (v1)") expect(openApiDoc.info.version).toBeDefined() expect(openApiDoc.info.description).toBeDefined() })