No logo available for Ditto to DuckDB connector icon

Load Ditto data to DuckDB

Build a Ditto to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Ditto API base URL, auth, endpoints, and incremental loading.

SourceDittoDitto API DocumentationDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

Ditto is a data synchronization platform providing an HTTP API for interacting with distributed data stores. Everything needed to build a working Ditto → 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 Ditto to DuckDB pipeline

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

Prompt
Run uvx dlthub-init@latest to build a pipeline from Ditto 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 Ditto 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.


Ditto API at a glance

Base URLhttps://{YOUR_CLOUD_URL_ENDPOINT}/api/v5
Example endpointPOST api/v5/store/find
Records found atdocuments
Authenticationall requests require an Authorization header with a Bearer token — sent in the Authorization header, prefixed Bearer
PaginationCursor-based via option=cursor(<cursor-id>), next cursor at cursor, page size via option=size(<count>) (default 25, max 200)
API referencehttps://docs.ditto.live/cloud/http-api/auth-and-params

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


How do I authenticate with the Ditto API?

The API uses bearer token authentication. Requests must include the 'Authorization' header with the format 'Bearer ', where the token is an API key or a JWT.

1. Get your credentials

To obtain an API key for the Ditto Cloud HTTP API, follow these steps in the Ditto Portal: 1. Log in to the portal and navigate to your application dashboard. 2. Select your specific app from the list. 3. Navigate to the 'Auth' section. 4. Click 'New API key' in the lower right corner. 5. Complete the 'Key configuration' form by providing a description, setting an expiration date, and assigning read/write permissions. 6. Click 'Create API Key'. 7. Copy and store the key securely, as it will not be displayed again. Ensure your user role has the 'Access API keys' permission enabled under Settings > Roles.

2. Add them to .dlt/secrets.toml

[sources.ditto_source] api_key = "your_actual_api_key_string"

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 Ditto data can I load into DuckDB?

These are the Ditto endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
things/api/2/thingsGETRetrieve visible things
search_things/api/2/search/thingsGETSearch things with RQL filters and paging
search_things_count/api/2/search/things/countGETGet count of things matching search filter
store_find/api/v5/store/findPOSTdocumentsFind documents in cloud store
store_count/api/v5/store/countPOSTCount documents matching query
store_execute/api/v5/store/executePOSTExecute store operations
connections/api/2/connectionsGETList all connections

How do I load only new Ditto records?

The Ditto API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

{"name": "store_find", "endpoint": { "path": "api/v5/store/find", # Replace with a field that increases on every write. "incremental": {"cursor_path": "REPLACE_ME", "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 Ditto pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading store/execute and auth/webhook/secret from the Ditto API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def ditto_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://{YOUR_CLOUD_URL_ENDPOINT}/api/v5", "auth": {"type": "bearer", "token": api_key}, }, "resources": [ {"name": "store_find", "endpoint": {"path": "api/v5/store/find", "data_selector": "documents"}}, {"name": "search_things", "endpoint": {"path": "api/2/search/things"}} ], } yield from rest_api_resources(config) def load_ditto_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="ditto_pipeline", destination="duckdb", dataset_name="ditto_data", ) load_info = pipeline.run(ditto_source()) print(load_info) if __name__ == "__main__": load_ditto_to_duckdb()

Run it with python ditto_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 Ditto 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):

import dlt data = dlt.pipeline("ditto_pipeline").dataset() df = data.store_find.df() print(df.head())

SQL:

SELECT * FROM ditto_data.store_find LIMIT 10;

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


How do I deploy the Ditto 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 Ditto 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 Ditto data to?

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

DestinationExample value
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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

Was this page helpful?

Community Hub

Need more dlt context for Ditto to DuckDB?

Request dlt skills, commands, AGENT.md files, and AI-native context.