Load DealCloud data to DuckDB
Build a DealCloud to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the DealCloud API base URL, auth, endpoints, and incremental loading.
DealCloud is a data platform providing REST APIs for accessing and managing organizational data and records. Everything needed to build a working DealCloud → 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 DealCloud to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from DealCloud 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 DealCloud 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.
DealCloud API at a glance
| Base URL | https://{your_site_domain} |
| Example endpoint | GET api/rest/v4/data/entrydata/rows/{entryTypeId} |
| Records found at | rows |
| Authentication | OAuth2 Bearer token generated via client credentials flow — sent in the Authorization header, prefixed Bearer |
| Pagination | Offset-based page size via limit (or pageSize) (default 1000, max 10000). The main Data API (Rows/Query) uses offset-based pagination via 'limit' and 'skip' parameters. A separate, older User Activity endpoint uses 'pageNumber' and 'pageSize'. No cursor-based pagination is used. |
| Incremental field | modifiedSince |
| API reference | https://api.docs.dealcloud.com/docs/token |
These values come from the DealCloud API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the DealCloud API?
DealCloud uses an OAuth2 Client Credentials flow. Requests must include an 'Authorization' header with the value 'Bearer {access_token}'.
1. Get your credentials
- Log in to your DealCloud account.\n2. Ensure your user group has the "API" capability enabled in Admin > User Management > Capabilities > Site Areas.\n3. Click the User icon in the top-right corner and select Profile.\n4. Scroll down to the API Key section and click Enable.\n5. Click Copy API Key to Clipboard. This key acts as your client secret for OAuth2 authentication. Note your client ID, which is often managed or provided alongside the key, to use in your credentials configuration.
2. Add them to .dlt/secrets.toml
[sources.dealcloud_source] client_id = "REPLACE_ME"
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 DealCloud data can I load into DuckDB?
These are the DealCloud endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| rows | api/rest/v4/data/entrydata/rows/{entryTypeId} | GET | rows | Retrieves full object records |
| rows_query | api/rest/v4/data/entrydata/rows/query/{entryTypeId} | POST | rows | Query data with filtering in request body |
| history | api/rest/v4/data/entrydata/{entryTypeId}/entries/history | GET | Get history of modified/deleted entries | |
| all_history | api/rest/v4/data/entrydata/{entryTypeId}/entries/allHistory | GET | Get all history including system updates | |
| entry_types | api/rest/v4/data/entrytypes | GET | Lists available entry types |
How do I load only new DealCloud records?
DealCloud exposes modifiedSince on api/rest/v4/data/entrydata/rows/{entryTypeId}, 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.
{"name": "rows", "endpoint": { "path": "api/rest/v4/data/entrydata/rows/{entryTypeId}", "data_selector": "rows", "incremental": {"cursor_path": "modifiedSince", "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 DealCloud pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading /api/rest/v1/oauth/token and /api/rest/v4/data from the DealCloud API into DuckDB:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def dealcloud_source(client_id=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://{your_site_domain}", "auth": {"type": "bearer", "token": client_id}, }, "resources": [ {"name": "rows", "endpoint": {"path": "api/rest/v4/data/entrydata/rows/{entryTypeId}", "data_selector": "rows"}}, {"name": "rows_query", "endpoint": {"path": "api/rest/v4/data/entrydata/rows/query/{entryTypeId}", "data_selector": "rows"}} ], } yield from rest_api_resources(config) def load_dealcloud_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="dealcloud_pipeline", destination="duckdb", dataset_name="dealcloud_data", ) load_info = pipeline.run(dealcloud_source()) print(load_info) if __name__ == "__main__": load_dealcloud_to_duckdb()
Run it with python dealcloud_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 DealCloud 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("dealcloud_pipeline").dataset() df = data.rows.df() print(df.head())
SQL:
SELECT * FROM dealcloud_data.rows LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the DealCloud 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 DealCloud loads into governed, documented models.
- Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.
What other destinations can I load DealCloud data to?
dlt loads into any of these — only the destination argument changes:
| Destination | Example 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 DealCloud to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.