Codat Python API Docs | dltHub

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

Last updated:

Codat is a financial data platform API that standardizes and aggregates accounting, banking, and spend data from multiple integrations for SMB companies. The REST API base URL is https://api.codat.io and all requests require an Authorization header with the Base64-encoded API key using the Basic scheme.

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 Codat data in under 10 minutes.


What data can I load from Codat?

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

ResourceEndpointMethodData selectorDescription
companiescompaniesGETresultsList companies with pagination (page, pageSize), query filter and orderBy; records include id, name, lastSync, dataConnections
connectionscompanies/{companyId}/connectionsGETresultsList a company's data connections (accounting, banking, commerce); records include id, status, platformName
accountscompanies/{companyId}/data/accountsGETresultsList the latest chart of accounts for a company (DataList: results, pageNumber, pageSize, totalResults)
invoicescompanies/{companyId}/connections/{connectionId}/data/invoicesGETresultsList invoices for a company connection, paginated via page/pageSize
billscompanies/{companyId}/connections/{connectionId}/data/billsGETresultsList bills for a company connection, paginated via page/pageSize
account_transactionscompanies/{companyId}/connections/{connectionId}/data/accountTransactionsGETresultsList account transactions; supports page, pageSize, query (e.g. modifiedDate filter) and orderBy; records carry modifiedDate
banking_transactionscompanies/{companyId}/connections/{connectionId}/data/banking-transactionsGETresultsList banking transactions; supports page, pageSize, query and orderBy; records carry modifiedDate
customerscompanies/{companyId}/connections/{connectionId}/data/commerce-customersGETresultsList commerce customers; supports page, pageSize, query and orderBy; records carry id, modifiedDate
customers_accountingcompanies/{companyId}/connections/{connectionId}/data/customersGETresultsList accounting customers for a company connection
supplierscompanies/{companyId}/connections/{connectionId}/data/suppliersGETresultsList accounting suppliers for a company connection
journal_entriescompanies/{companyId}/connections/{connectionId}/data/journalEntriesGETresultsList journal entries for a company connection

How do I authenticate with the Codat API?

Codat uses API keys for authentication; the API key must be Base64 encoded and sent in the 'Authorization' header of every request as 'Authorization: Basic BASE_64_ENCODED(API_KEY)'. The pre-encoded authorization header can be copied from the Codat Portal under Developers > API keys.

1. Get your credentials

  1. Log in to the Codat Portal (app.codat.io) with your Codat account. 2. In the top navigation bar, click Developers > API keys. 3. In the API Keys section, select (or create) an API key for your environment. 4. Copy the ready-made Authorization header value shown in the API Keys section — this is the Base64-encoded key (the string after 'Basic'), not the raw API key itself. Codat expects this value sent as 'Authorization: Basic BASE_64_ENCODED(API_KEY)' on every request to https://api.codat.io. Keep it secret and do not commit it to version control.

2. Add them to .dlt/secrets.toml

[sources.codat_source] api_key = "your_api_key_here"

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 Codat 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 codat_pipeline.py

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

Pipeline codat_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset codat_data The duckdb destination used duckdb:/codat.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 companies and connections from the Codat 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 codat_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.codat.io", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key}, }, "resources": [ {"name": "companies", "endpoint": {"path": "companies", "data_selector": "results"}}, {"name": "account_transactions", "endpoint": {"path": "companies/{companyId}/connections/{connectionId}/data/accountTransactions", "data_selector": "results"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="codat_pipeline", destination="duckdb", dataset_name="codat_data", ) load_info = pipeline.run(codat_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("codat_pipeline").dataset() sessions_df = data.companies.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM codat_data.companies LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("codat_pipeline").dataset() data.companies.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 Codat 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 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 Codat?

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