Voltage Python API Docs | dltHub

Voltage is a platform providing managed Bitcoin Lightning Network nodes and related APIs to manage nodes, wallets, payments, and node-level resources. The REST API base URL is https://api.voltage.cloud and All requests require an API key sent in a custom header..

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 Voltage data in under 10 minutes.

---

What data can I load from Voltage?

Here are some of the endpoints you can load from Voltage:

---

How do I authenticate with the Voltage API?

The REST API requires an API key in the request headers. Include the API key using the header name X-Voltage-Auth (shown in docs as 'x voltage auth') for voltage.cloud API endpoints. Some variant developer docs (voltageapi.com) also reference X-Api-Key for other environments; prefer X-Voltage-Auth for docs.voltage.cloud endpoints.

1. Get your credentials

1. Sign in to your Voltage team dashboard. 2) Open the left menu and expand the 'API' section. 3) Click 'Keys' (or 'API Keys'). 4) Click 'New Key' (or 'Generate Key'), give it a descriptive name and choose environment if prompted. 5) Save the generated key immediately — it will not be shown again. 6) Use that key in the X-Voltage-Auth header for API requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.voltage_api_source]
api_key = "your_voltage_api_key_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:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
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:

Copy
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 Voltage 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:

Copy
python voltage_api_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline voltage_api_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset voltage_api_data
The duckdb destination used duckdb:/voltage_api.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline voltage_api_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 nodes and payments from the Voltage API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def voltage_api_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.voltage.cloud",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "nodes", "endpoint": {"path": "organizations/{organization_id}/nodes", "data_selector": "nodes"}},
            {"name": "payments", "endpoint": {"path": "organizations/{organization_id}/environments/{environment_id}/payments", "data_selector": "(payment object returned on GET; list responses may be under payments)"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="voltage_api_pipeline",
        destination="duckdb",
        dataset_name="voltage_api_data",
    )
    load_info = pipeline.run(voltage_api_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):

Copy
import dlt

data = dlt.pipeline("voltage_api_pipeline").dataset()
sessions_df = data.nodes.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM voltage_api_data.nodes LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("voltage_api_pipeline").dataset()
data.nodes.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 Voltage data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures

If you receive 401/403 responses: verify you are sending the generated API key in the X-Voltage-Auth header (case-insensitive header name). Ensure the key is active, belongs to the correct team/environment, and was copied fully (it is shown only once when generated).

Rate limits and 429 responses

The docs use standard HTTP status codes; if you encounter 429, implement exponential backoff and retry. There is no explicit global rate limit documented — treat retries conservatively.

Pagination and 202 behavior

Some endpoints (payments creation) return 202 Accepted — creation is asynchronous. You must poll the GET payment endpoint to obtain the final status. List endpoints may return arrays under a named key (e.g., "nodes"). Check the exact top-level JSON key in responses before mapping data selectors.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

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.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack