No logo available for Faraday to DuckDB connector icon

Load Faraday data to DuckDB

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

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

Faraday is a customer context platform providing infrastructure for predicting customer behavior and managing consumer identity data through a REST API. Everything needed to build a working Faraday → 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 Faraday 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 Faraday 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 Faraday 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.


Faraday API at a glance

Base URLhttps://api.faraday.ai/v1
Example endpointGET v1/connections
Authenticationrequests require a Bearer token in the Authorization header — sent in the Authorization header, prefixed Bearer
Also requiredconnectionId
PaginationNot paginated
Incremental fieldupdated_at
Record idid
API referencehttps://faraday.ai/docs/reference

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


How do I authenticate with the Faraday API?

All requests require an API key passed in the Authorization header using the Bearer authentication scheme (e.g., 'Authorization: Bearer YOUR_API_KEY').

1. Get your credentials

To obtain your Faraday API credentials, log in to your Faraday dashboard, navigate to the Settings page, and locate your API key. You will use this key for Bearer authentication in your API requests.

2. Add them to .dlt/secrets.toml

[sources.faraday_source] faraday_api_key = "your_api_key_here"

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

These are the Faraday endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
streams/v1/streamsGETList all streams
datasets/v1/datasetsGETList all datasets
webhook_endpoints/v1/webhook_endpointsGETList webhook endpoints
targets/v1/targetsGETList all targets
connections/v1/connectionsGETList all connections

How do I load only new Faraday records?

Faraday exposes updated_at on v1/connections, 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": "connections", "endpoint": { "path": "v1/connections", "incremental": {"cursor_path": "updated_at", "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 Faraday pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading connections and accounts from the Faraday API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def faraday_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.faraday.ai/v1", "auth": {"type": "bearer", "token": api_key}, }, "resources": [ {"name": "connections", "endpoint": {"path": "v1/connections"}}, {"name": "streams", "endpoint": {"path": "v1/streams"}} ], } yield from rest_api_resources(config) def load_faraday_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="faraday_pipeline", destination="duckdb", dataset_name="faraday_data", ) load_info = pipeline.run(faraday_source()) print(load_info) if __name__ == "__main__": load_faraday_to_duckdb()

Run it with python faraday_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 Faraday 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("faraday_pipeline").dataset() df = data.connections.df() print(df.head())

SQL:

SELECT * FROM faraday_data.connections LIMIT 10;

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


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

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