Load WebSocket data to DuckDB

WebSocket is a communication protocol that provides full-duplex, persistent, bidirectional channels over a single TCP connection, often used alongside REST APIs for real-time data streaming. Everything needed to build a working WebSocket → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.

---

Build your WebSocket to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from WebSocket to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the WebSocket API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.

---

WebSocket API at a glance

These values come from the WebSocket API reference — the authoritative source if anything here looks out of date.

---

How do I authenticate with the WebSocket API?

Authentication is typically handled by passing a token in the connection URL or via an initial message after the WebSocket handshake. Standard patterns include appending ?token= or ?access_token= to the URL, or sending a JSON payload such as {"authorization": "TOKEN"} immediately upon connection.

1. Get your credentials

To obtain API credentials for a REST or WebSocket API integrated with dlt, follow the specific documentation provided by the API service provider (e.g., emailing a specific support contact or accessing an 'API Keys' section in your user account dashboard). Once obtained, do not hardcode these credentials in your scripts. Instead, store them securely in the .dlt/secrets.toml file or use environment variables to ensure they remain protected during local development and production deployments.

2. Add them to .dlt/secrets.toml

Copy
[sources.websocket_source]
api_key = "your_api_key_here"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.

---

What WebSocket data can I load into DuckDB?

These are the WebSocket endpoints dlt can load into DuckDB:

---

How do I load only new WebSocket records?

WebSocket exposes updated_at on users, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.

Copy
{"name": "users", "endpoint": {
    "path": "users",
    "incremental": {"cursor_path": "updated_at", "initial_value": "2024-01-01T00:00:00Z"},
}}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.

---

What does the generated WebSocket pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading client and resources from the WebSocket API into DuckDB:

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

@dlt.source
def websocket_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "wss://api.example.com/v1",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "users", "endpoint": {"path": "users"}},
            {"name": "issues", "endpoint": {"path": "issues"}}
        ],
    }
    yield from rest_api_resources(config)


def load_websocket_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="websocket_pipeline",
        destination="duckdb",
        dataset_name="websocket_data",
    )
    load_info = pipeline.run(websocket_source())
    print(load_info)


if __name__ == "__main__":
    load_websocket_to_duckdb()

Run it with python websocket_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.

---

How do I query WebSocket data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("websocket_pipeline").dataset()
df = data.users.df()
print(df.head())

SQL:

Copy
SELECT * FROM websocket_data.users LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.

---

How do I deploy the WebSocket to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

• Deploy & schedule — run the pipeline as a managed job with automatic retries.
• Monitor — observable job queues, alerting, and load metrics for every run.
• Transform — promote raw WebSocket loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load WebSocket data to?

dlt loads into any of these — only the destination argument changes:

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.

---

Next steps

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack