Duda Collections API Python API Docs | dltHub
Build a Duda Collections API-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.
Last updated:
Duda Collections API is a RESTful interface for managing website collections, fields, and data content across Duda partner and app platforms. The REST API base URL is https://api.duda.co/api and all requests require HTTP Basic authentication, and site-specific requests also require a Bearer token 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 add "dlt[hub]" and start loading Duda Collections API data in under 10 minutes.
What data can I load from Duda Collections API?
Here are some of the endpoints you can load from Duda Collections API:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| collections_list | /api/sites/multiscreen/{site_name}/collection | GET | List all collections for a multiscreen site. | |
| collection_get | /api/sites/multiscreen/{site_name}/collection/{collection_name} | GET | Get fields and rows for a specific collection. | |
| app_collections_list | /api/integrationhub/application/site/{site_name}/content/collection | GET | App Store: list collections for an installed app/site. | |
| app_collection_get | /api/integrationhub/application/site/{site_name}/content/collection/{collection_name} | GET | App Store: get a collection for an installed app/site. | |
| collection_rows_query | /api/sites/multiscreen/{site_name}/collection/{collection_name}/query | POST | Query collection data with filters and pagination. |
How do I authenticate with the Duda Collections API API?
Duda APIs use HTTP Basic Authentication for account-level access by sending a base64 encoded 'username
' string in the 'Authorization' header. Site-specific operations additionally require an 'X-DUDA-ACCESS-TOKEN' header containing a 'Bearer ' string.1. Get your credentials
To obtain your API credentials for the Duda REST API, follow these steps: 1. Log in to your Duda dashboard. 2. Navigate to the Business Tools section. 3. Select API Access. 4. Here you will find your assigned username and password. If you are setting this up for the first time, you may need to reset or generate these credentials. Note that resetting them may impact existing integrations using these keys.
2. Add them to .dlt/secrets.toml
[sources.duda_collections_api_source] # Replace with your actual credentials retrieved from the dashboard\n# The API requires a Base64 encoded string of 'username:password'\napi_key = "dGhlX3VzZXJuYW1lOnRoZV9wYXNzd29yZA==" \n# For dlt headers, you might need to supply these separately or as a pre-encoded header\nduda_username = "your_username"\nduda_password = "your_password"
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 init uv add "dlt[hub]"
1. Install the dlt AI harness:
uv run dlthub 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:
uv run dlthub ai toolkit install rest-api-pipeline
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 Duda Collections API 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:
uv run python duda_collections_api_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline duda_collections_api_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset duda_collections_api_data The duckdb destination used duckdb:/duda_collections_api.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
uv run dlthub 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 /sites/multiscreen/{site_name}/collection and /sites/multiscreen/{site_name}/collection/{collection_name} from the Duda Collections API 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 duda_collections_api_source(api_user=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.duda.co/api", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_user}, }, "resources": [ {"name": "collections_list", "endpoint": {"path": "api/sites/multiscreen/{site_name}/collection"}}, {"name": "collection_get", "endpoint": {"path": "api/sites/multiscreen/{site_name}/collection/{collection_name}"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="duda_collections_api_pipeline", destination="duckdb", dataset_name="duda_collections_api_data", ) load_info = pipeline.run(duda_collections_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):
import dlt data = dlt.pipeline("duda_collections_api_pipeline").dataset() sessions_df = data.collection_get.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM duda_collections_api_data.collection_get LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("duda_collections_api_pipeline").dataset() data.collection_get.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 Duda Collections API 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 harness:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-platform— Deploy, schedule, and monitor your pipeline in production.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform
Was this page helpful?
Community Hub
Need more dlt context for Duda Collections API?
Request dlt skills, commands, AGENT.md files, and AI-native context.