Bun Python API Docs | dltHub

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

Last updated:

REST API documentation for Bun is not directly available; Bun focuses on JavaScript runtime and tooling. For REST API details, refer to general REST principles and practices. The REST API base URL is `` and no provider-managed authentication; auth depends on the Bun server implementation.

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


What data can I load from Bun?

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

ResourceEndpointMethodData selectorDescription
posts/api/postsGETList posts (example from Bun docs; returns a top-level JSON array)
post_by_id/api/posts/:idGETGet post by id (returns a JSON object)
status/api/statusGETSimple status endpoint (example returns plain text "OK")
users/users/:idGETDynamic user route example (returns text in docs; may be JSON in implementations)
api_wildcard/api/*GETWildcard example returning JSON { message: "Not found" } with 404 status

How do I authenticate with the Bun API?

Bun itself does not enforce an auth scheme. Any required authentication (Bearer tokens, API keys, HTTP Basic) must be implemented by the Bun server and communicated via custom headers or route guards.

1. Get your credentials

Not applicable: Bun does not issue credentials. Implement and obtain credentials from the specific Bun-based application you deploy (e.g., your server’s admin UI or configuration).

2. Add them to .dlt/secrets.toml

[sources.bun_source]

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 Bun 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 bun_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline bun_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 posts and post_by_id from the Bun 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 bun_source(=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "", "auth": { "type": "", "": , }, }, "resources": [ {"name": "posts", "endpoint": {"path": "api/posts"}}, {"name": "post_by_id", "endpoint": {"path": "api/posts/:id"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="bun_pipeline", destination="duckdb", dataset_name="bun_data", ) load_info = pipeline.run(bun_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("bun_pipeline").dataset() sessions_df = data.posts.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM bun_data.posts LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("bun_pipeline").dataset() data.posts.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 Bun 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 Bun?

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