No logo available for Cinchy to DuckDB connector icon

Load Cinchy data to DuckDB

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

SourceCinchyAPI overview | Cinchy Platform DocumentationDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

Cinchy is an enterprise data platform that provides a REST API for executing CQL queries, accessing saved queries, health checks, jobs, and secrets management. Everything needed to build a working Cinchy → 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 Cinchy 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 Cinchy 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 Cinchy 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.


Cinchy API at a glance

Base URLhttps://cinchy.net
Example endpointGET api/v1.0/[Domain]/[QueryName]
Authenticationall requests require a Bearer token in the Authorization header — sent in the Authorization header, prefixed Bearer
PaginationOffset-based via cursorPropertyName, page size via RowCount. For the ExecuteCQL API, use StartRow (offset) and RowCount (limit). For general REST API data syncs, Cinchy supports both Cursor (requires cursorPropertyName and pathInResponse) and Offset (requires limitField and offsetField) pagination types.
API referencehttps://platform.docs.cinchy.com/api-guide/api-overview/api-authentication

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


How do I authenticate with the Cinchy API?

All requests require an 'Authorization' header containing the token prefixed with the word 'Bearer' (e.g., 'Bearer ').

1. Get your credentials

To obtain credentials for the Cinchy REST API, you must first register a client within the Cinchy platform to receive a 'client_id' and 'client_secret'. Once you have these, you can obtain a Bearer access token by making a POST request to the identity endpoint (typically 'https:///identity/connect/token'). The request body must be form-urlencoded and include your 'client_id', 'client_secret', 'username', 'password', and 'grant_type=password'. Alternatively, for Cinchy v5.5+, you may generate a 'Personal Access Token' (PAT) directly through the Cinchy user interface.

2. Add them to .dlt/secrets.toml

[sources.cinchy_source] cinchy_client_id = "your_client_id_here" cinchy_client_secret = "your_client_secret_here" cinchy_username = "your_username_here" cinchy_password = "your_password_here" cinchy_base_url = "https://your-cinchy-instance.com"

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

These are the Cinchy endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
saved_queries/api/v1.0/[Domain]/[QueryName]GETExecutes a saved query and returns data via REST API
execute_cql/API/ExecuteCQLPOSTExecutes Cinchy Query Language directly
jobs/api/jobsPOSTTriggers a configured batch data sync job
healthcheck/healthcheckGETStandard system health check endpoint
token/identity/connect/tokenPOSTRetrieves an OAuth 2.0 bearer access token

How do I load only new Cinchy records?

The Cinchy 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": "saved_queries", "endpoint": { "path": "api/v1.0/[Domain]/[QueryName]", # 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 Cinchy pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /identity/connect/token and /api/v1.0/ (for accessing saved query APIs) from the Cinchy API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def cinchy_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://cinchy.net", "auth": {"type": "bearer", "token": access_token}, }, "resources": [ {"name": "saved_queries", "endpoint": {"path": "api/v1.0/[Domain]/[QueryName]"}}, {"name": "token", "endpoint": {"path": "identity/connect/token"}} ], } yield from rest_api_resources(config) def load_cinchy_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="cinchy_pipeline", destination="duckdb", dataset_name="cinchy_data", ) load_info = pipeline.run(cinchy_source()) print(load_info) if __name__ == "__main__": load_cinchy_to_duckdb()

Run it with python cinchy_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 Cinchy 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("cinchy_pipeline").dataset() df = data.saved_queries.df() print(df.head())

SQL:

SELECT * FROM cinchy_data.saved_queries LIMIT 10;

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


How do I deploy the Cinchy 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 Cinchy 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 Cinchy 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 Cinchy to DuckDB?

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