chainlink-apimatic-sdk 0.0.2

SDKs for streaming APIs

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

• Chains
• Tokens
• Lanes

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime