Swap Coffee Python API Docs | dltHub

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

Last updated:

The swap.coffee API is a public RESTful service for token swapping, supporting liquidity pool information and multi-asset routing. It uses a unified Yield Aggregator Service API. The API allows building transactions for token swaps. The REST API base URL is https://api.swap.coffee and Public API; optional developer API key available for higher rate limits.

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


What data can I load from Swap Coffee?

Here are some of the endpoints you can load from Swap Coffee:

ResourceEndpointMethodData selectorDescription
quote/v1/quoteGETGet instant quote for amount between two tokens (example in docs).
route/v1/routeGETroutesBuild optimal swap route; returns one or more route objects.
tokens/v1/tokensGETtokensList of supported tokens/jettons.
pools/v1/pools/{pool_id}GETReturns information about a given liquidity pool for a given blockchain.
health/v1/healthGETService health/status endpoint if available.

How do I authenticate with the Swap Coffee API?

The API is public (no required authentication) but offers an optional API key for increased rate limits or commercial integrations.

1. Get your credentials

  1. Visit the developer docs or the 'Get API Key' Typeform link listed in the docs (https://swapcoffee.typeform.com/to/Zx49Ho3y). 2) Fill and submit the Typeform as instructed to request a developer API key. 3) Await delivery of the key via the contact method you provided (email/Telegram).

2. Add them to .dlt/secrets.toml

[sources.swap_coffee_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 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 Swap Coffee 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 swap_coffee_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline swap_coffee_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 quote and route from the Swap Coffee 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 swap_coffee_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.swap.coffee", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "quote", "endpoint": {"path": "v1/quote"}}, {"name": "route", "endpoint": {"path": "v1/route", "data_selector": "routes"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="swap_coffee_pipeline", destination="duckdb", dataset_name="swap_coffee_data", ) load_info = pipeline.run(swap_coffee_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("swap_coffee_pipeline").dataset() sessions_df = data.quote.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM swap_coffee_data.quote LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("swap_coffee_pipeline").dataset() data.quote.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 Swap Coffee 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 Swap Coffee?

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