Kaleido Python API Docs | dltHub
Build a Kaleido-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Kaleido provides a comprehensive REST API for blockchain and digital asset management. The API supports administrators, network operators, and DApps developers. For detailed documentation, visit https://api.kaleido.io/platform.html. The REST API base URL is https://api.kaleido.io and All administrative API requests require a Bearer token; node REST Gateway uses basic authentication with application credentials..
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Kaleido data in under 10 minutes.
What data can I load from Kaleido?
Here are some of the endpoints you can load from Kaleido:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| apikeys | /apikeys | GET | (top-level array) | List API Keys (org‑level) |
| apikey | /apikeys/{apikey_id} | GET | object | Get a specific API Key |
| regions | /regions | GET | (top-level array) | List deployment regions and endpoints |
| releases | /releases | GET | (top-level array) | List environment runtime releases |
| nodes_status | /nodes/{node_id}/status | GET | object | Get node runtime status (contains urls, rpc, wss, kaleido_connect) |
| abis | /abis | GET | (top-level array) | List installed contract ABIs on a node |
| contracts | /contracts | GET | (top-level array) | List contract instances on a node |
| eventstreams | /eventstreams | GET | (top-level array) | List event streams on a node |
| subscriptions | /subscriptions | GET | (top-level array) | List event stream subscriptions on a node |
| application_credentials | /application_credentials | GET | (top-level array) | List app credentials for an environment |
How do I authenticate with the Kaleido API?
Platform APIs use Bearer token authentication; node REST gateways use basic auth with application credentials.
1. Get your credentials
- Log into the Kaleido Console (https://console.kaleido.io). 2) Navigate to Organization → API Keys or Environment → Application Credentials. 3) Create a new API Key or Application Credential and copy the one‑time secret. 4) For node REST gateway, open the node "+ Connect" panel to view the node‑specific connect URL and credentials.
2. Add them to .dlt/secrets.toml
[sources.kaleido_source] api_key = "your_bearer_token_here"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Kaleido API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python kaleido_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline kaleido_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset kaleido_data The duckdb destination used duckdb:/kaleido.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline kaleido_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads abis and contracts from the Kaleido API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def kaleido_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.kaleido.io", "auth": { "type": "bearer", "token": api_key, }, }, "resources": [ {"name": "abis", "endpoint": {"path": "{node_gateway}/abis"}}, {"name": "contracts", "endpoint": {"path": "{node_gateway}/contracts"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="kaleido_pipeline", destination="duckdb", dataset_name="kaleido_data", ) load_info = pipeline.run(kaleido_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("kaleido_pipeline").dataset() sessions_df = data.contracts.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM kaleido_data.contracts LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("kaleido_pipeline").dataset() data.contracts.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Kaleido data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for Kaleido?
Request dlt skills, commands, AGENT.md files, and AI-native context.