Getting Started with CCIP directory and configuration REST API (v1)
Introduction
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. For new integrations, prefer the CCIP Tools REST API (v2) where it meets your needs.
REST 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.
To get started quickly, you can download our Postman Collection which includes all endpoints and example requests.
Install the Package
The package is compatible with Python versions 3.7+.
Install the package from PyPi using the following pip command:
pip install chainlink-apimatic-sdk==0.0.2
You can also view the package at: https://pypi.python.org/pypi/chainlink-apimatic-sdk/0.0.2
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| environment | Environment |
The API environment. Default: Environment.PRODUCTION |
| http_client_instance | Union[Session, HttpClientProvider] |
The Http Client passed from the sdk user for making requests |
| override_http_client_configuration | bool |
The value which determines to override properties of the passed Http Client from the sdk user |
| http_call_back | HttpCallBack |
The callback value that is invoked before and after an HTTP call is made to an endpoint |
| timeout | float |
The value to use for connection timeout. Default: 30 |
| max_retries | int |
The number of times to retry an endpoint call if it fails. Default: 0 |
| backoff_factor | float |
A backoff factor to apply between attempts after the second try. Default: 2 |
| retry_statuses | Array of int |
The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
| retry_methods | Array of string |
The http methods on which retry is to be done. Default: ["GET", "PUT"] |
| proxy_settings | ProxySettings |
Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | LoggingConfiguration |
The SDK logging configuration for API calls |
The API client can be initialized as follows:
Code-Based Client Initialization
import logging
from ccipdirectoryandconfigurationrestapiv1.ccipdirectoryandconfigurationrestapiv_1_client import Ccipdirectoryandconfigurationrestapiv1Client
from ccipdirectoryandconfigurationrestapiv1.configuration import Environment
from ccipdirectoryandconfigurationrestapiv1.logging.configuration.api_logging_configuration import LoggingConfiguration
from ccipdirectoryandconfigurationrestapiv1.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from ccipdirectoryandconfigurationrestapiv1.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
client = Ccipdirectoryandconfigurationrestapiv1Client(
environment=Environment.PRODUCTION,
logging_configuration=LoggingConfiguration(
log_level=logging.INFO,
request_logging_config=RequestLoggingConfiguration(
log_body=True
),
response_logging_config=ResponseLoggingConfiguration(
log_headers=True
)
)
)
Environment-Based Client Initialization
from ccipdirectoryandconfigurationrestapiv1.ccipdirectoryandconfigurationrestapiv_1_client import Ccipdirectoryandconfigurationrestapiv1Client
# Specify the path to your .env file if it’s located outside the project’s root directory.
client = Ccipdirectoryandconfigurationrestapiv1Client.from_environment(dotenv_path='/path/to/.env')
See the Environment-Based Client Initialization section for details.
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | Default Production server |
| ENVIRONMENT2 | Development server |
List of APIs
SDK Infrastructure
Configuration
- ProxySettings
- Environment-Based Client Initialization
- AbstractLogger
- LoggingConfiguration
- RequestLoggingConfiguration
- ResponseLoggingConfiguration
HTTP
Utilities
Metadata
Release files for chainlink-apimatic-sdk 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| chainlink_apimatic_sdk-0.0.2.tar.gz | 33.7 kB | Without provenance | Details for chainlink_apimatic_sdk-0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| chainlink_apimatic_sdk-0.0.2-py3-none-any.whl | Python 3 | none | any | Details for chainlink_apimatic_sdk-0.0.2-py3-none-any.whl |
Total release size: 105.0 kB
Release files / chainlink_apimatic_sdk-0.0.2.tar.gz
| Download URL | chainlink_apimatic_sdk-0.0.2.tar.gz |
|---|---|
| Size | 33.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
af1e32a548ca5386461df4febb6651e90b3c3cb04acae7aa7ee0171c3ab65128
|
|
BLAKE2b-256 checksum How to use checksums |
8d8067e8c576f4eb69987e5e701b02045814c2c560b611a5d5569a434d6b5f9f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Release files / chainlink_apimatic_sdk-0.0.2-py3-none-any.whl
| Download URL | chainlink_apimatic_sdk-0.0.2-py3-none-any.whl |
|---|---|
| Size | 71.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d3770958304429e2457854b3c6bc86d96e58e65f6adf13097323b45637c1472d
|
|
BLAKE2b-256 checksum How to use checksums |
5df38fbeb8d1a8af4ef653c9f68b66386a96f9b8986a5e50ae7df0d0e7978290
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Security for chainlink-apimatic-sdk 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.