Rutter Python API Docs | dltHub

Build a Rutter-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Rutter API allows creating connections programmatically via REST. It requires client_id and client_secret in Base64. Rutter returns specific error codes for unsupported endpoints. The REST API base URL is https://production.rutterapi.com/versioned and All requests require HTTP Basic authentication (Base64 client_id:client_secret) and X-Rutter-Version header; list endpoints also need an access_token query parameter..

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 pip install "dlt[workspace]" and start loading Rutter data in under 10 minutes.


What data can I load from Rutter?

Here are some of the endpoints you can load from Rutter:

ResourceEndpointMethodData selectorDescription
connectionsconnectionsGETconnectionsList all connections for the organization
connectionconnections/:idGETFetch a single connection object
connections_access_tokenconnections/access_tokenGETExchange/fetch an access_token for a connection
connection_statusconnections/statusGETstatusFetch connection sync status
accountsaccounting/accountsGETaccountsList accounting accounts
transactionsaccounting/transactionsGETtransactionsList accounting transactions
customersaccounting/customersGETcustomersList customers
invoicesaccounting/invoicesGETinvoicesList invoices
orderscommerce/ordersGETordersList commerce orders
productscommerce/productsGETproductsList commerce products
platformsplatformsGETplatformsList supported platforms

How do I authenticate with the Rutter API?

Rutter expects an Authorization header with value Basic <base64(client_id:client_secret)> on every request. For connection‑scoped calls include access_token=<ACCESS_TOKEN> as a query parameter and set the X‑Rutter‑Version header to a supported API date (e.g., 2024-08-31).

1. Get your credentials

  1. Sign in to https://dashboard.rutterapi.com/ or create an account.
  2. In the dashboard create or view an API environment (sandbox or production).
  3. Copy the client_id and client_secret shown for that environment.
  4. Base64‑encode "client_id:client_secret" and use in the Authorization header as Basic .

2. Add them to .dlt/secrets.toml

[sources.rutter_source] client_id = "your_client_id" client_secret = "your_client_secret"

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 venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

dlt 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:

dlt ai toolkit rest-api-pipeline install

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 Rutter 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:

python rutter_pipeline.py

If everything is configured correctly, you'll see output like this:

Pipeline rutter_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset rutter_data The duckdb destination used duckdb:/rutter.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

dlt pipeline rutter_pipeline 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 accounts and transactions from the Rutter 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 rutter_source(client_id, client_secret=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://production.rutterapi.com/versioned", "auth": { "type": "http_basic", "": client_id, client_secret, }, }, "resources": [ {"name": "accounts", "endpoint": {"path": "accounting/accounts", "data_selector": "accounts"}}, {"name": "transactions", "endpoint": {"path": "accounting/transactions", "data_selector": "transactions"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="rutter_pipeline", destination="duckdb", dataset_name="rutter_data", ) load_info = pipeline.run(rutter_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("rutter_pipeline").dataset() sessions_df = data.accounts.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM rutter_data.accounts LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("rutter_pipeline").dataset() data.accounts.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 Rutter data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample 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 Workbench:

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Rutter?

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