Atlar Python API Docs | dltHub

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

Last updated:

A REST API uses HTTP methods to interact with resources, following the principles of Representational State Transfer for efficient, reliable, and scalable web services. It relies on CRUD operations for resource management. For Atlar's API, refer to their official documentation. The REST API base URL is https://api.atlar.com and Supports OAuth2 (Bearer tokens) or HTTP Basic; OAuth2 bearer recommended..

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


What data can I load from Atlar?

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

ResourceEndpointMethodData selectorDescription
accountsfinancial-data/v2/accountsGETitemsList accounts (paginated list in items)
accountfinancial-data/v2/accounts/{id}GETGet single account by id
transactionsfinancial-data/v2/transactionsGETitemsList transactions (paginated)
credit_transferspayments/v2/credit-transfersGETitemsList credit transfers (paginated)
direct_debitspayments/v2/direct-debitsGETitemsList direct debits (paginated)
paymentspayments/v2/credit-transfers/{id}GETGet single payment/credit transfer by id
webhooksv1/webhooksGETitemsList webhook configurations (paginated)

How do I authenticate with the Atlar API?

Use Authorization: Bearer <ACCESS_TOKEN> for OAuth2, or HTTP Basic with ACCESS_KEY:SECRET in the request.

1. Get your credentials

  1. In the Atlar dashboard go to User Management → Programmatic access. 2) Create a programmatic access user to obtain an ACCESS_KEY and SECRET. 3) POST grant_type=client_credentials to https://api.atlar.com/iam/v2beta/oauth2/token using -u '<ACCESS_KEY>:'. 4) Use the returned access_token in the Authorization: Bearer header for API calls; alternatively, use HTTP Basic with ACCESS_KEY:SECRET.

2. Add them to .dlt/secrets.toml

[sources.atlar_api_source] access_key = "your_access_key_here" secret = "your_secret_here" # or if you store an OAuth token access_token = "your_oauth_access_token_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 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 Atlar 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 atlar_api_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline atlar_api_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 Atlar 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 atlar_api_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.atlar.com", "auth": { "type": "bearer", "token": access_token, }, }, "resources": [ {"name": "accounts", "endpoint": {"path": "financial-data/v2/accounts", "data_selector": "items"}}, {"name": "transactions", "endpoint": {"path": "financial-data/v2/transactions", "data_selector": "items"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="atlar_api_pipeline", destination="duckdb", dataset_name="atlar_api_data", ) load_info = pipeline.run(atlar_api_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("atlar_api_pipeline").dataset() sessions_df = data.accounts.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM atlar_api_data.accounts LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("atlar_api_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 Atlar 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 Atlar?

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