Load Dataverse data to DuckDB

Dataverse is a research data repository software that exposes its functionality through a native REST API. Everything needed to build a working Dataverse → 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 Dataverse 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 Dataverse 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 Dataverse 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.

---

Dataverse API at a glance

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

---

How do I authenticate with the Dataverse API?

Authentication is performed by sending an API token in the X-Dataverse-key HTTP header. The token is an alphanumeric string unique to the server instance.

1. Get your credentials

To obtain your Dataverse API token, log in to your Dataverse installation, click on your account name in the navigation bar, and select API Token from the dropdown menu. In the resulting tab, click Create Token to generate your unique credential. If your token is compromised or expires, you can use the same menu to Recreate Token. Treat this token with the same security precautions as a password.

2. Add them to .dlt/secrets.toml

Copy
[sources.dataverse_source]
api_key = "your_api_token_here"
server_url = "https://your-dataverse-instance.org"

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

These are the Dataverse endpoints dlt can load into DuckDB:

---

How do I load only new Dataverse records?

Dataverse exposes modifiedon on api/data/v9.2/accounts, 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": "accounts", "endpoint": {
    "path": "api/data/v9.2/accounts",
    "data_selector": "value",
    "incremental": {"cursor_path": "modifiedon", "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 Dataverse pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /api/dataverses/{alias}/contents and /api/users/:me from the Dataverse API into DuckDB:

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

@dlt.source
def dataverse_source(api_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://your-server-url.org/api/",
            "auth": {"type": "bearer", "token": api_token},
        },
        "resources": [
            {"name": "accounts", "endpoint": {"path": "api/data/v9.2/accounts", "data_selector": "value"}},
            {"name": "contacts", "endpoint": {"path": "api/data/v9.2/contacts", "data_selector": "value"}}
        ],
    }
    yield from rest_api_resources(config)


def load_dataverse_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="dataverse_pipeline",
        destination="duckdb",
        dataset_name="dataverse_data",
    )
    load_info = pipeline.run(dataverse_source())
    print(load_info)


if __name__ == "__main__":
    load_dataverse_to_duckdb()

Run it with python dataverse_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 Dataverse 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("dataverse_pipeline").dataset()
df = data.accounts.df()
print(df.head())

SQL:

Copy
SELECT * FROM dataverse_data.accounts LIMIT 10;

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

---

How do I deploy the Dataverse 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 Dataverse 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 Dataverse 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