Fermion Python API Docs | dltHub
Build a Fermion-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
To start live event streaming with Fermion, use the REST API endpoint. Authentication requires the "FERMION-API-KEY" header. The API initiates live streaming for participation tools. The REST API base URL is https://backend.codedamn.com/api and All requests require an API key provided in the FERMION-API-KEY header (API-key in header)..
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 Fermion data in under 10 minutes.
What data can I load from Fermion?
Here are some of the endpoints you can load from Fermion:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| get_user_detailed_analytics_data | api/public/get-user-detailed-analytics-data | GET | Retrieves detailed analytics for a user (public API endpoint listed in Fermion docs/dlthub guide) | |
| get_user_basic_profile_data | api/public/get-user-basic-profile-data | GET | Fetches basic profile information for a user | |
| get_user_lab_result | api/public/get-user-lab-result | GET | Gets lab result(s) for a user | |
| get_lab_details_bulk | api/public/get-lab-details-bulk | GET | Retrieves details for multiple labs at once | |
| get_live_event_session_stats | api/public/get-live-event-session-stats | GET | Obtains statistics for a live event session | |
| start_live_event_session_streaming | public/start-live-event-session-streaming | POST | Starts live event streaming; OpenAPI shows response is a top-level array of objects each with an "output" object that contains status and data or error/errorMessage |
How do I authenticate with the Fermion API?
Fermion uses an API-Key scheme: include header FERMION-API-KEY: <YOUR_API_KEY> on requests. Some public examples also accept a Bearer-style token in Authorization for SDKs, but the documented REST OpenAPI uses the FERMION-API-KEY header (apiKey in header).
1. Get your credentials
- Sign in to your Fermion (codedamn) account/dashboard. 2) Open Settings / API Keys (or Integrations / API). 3) Create a new API key / token and copy it. 4) Use that value as the FERMION-API-KEY header value in requests.
2. Add them to .dlt/secrets.toml
[sources.fermion_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 Fermion 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 fermion_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline fermion_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset fermion_data The duckdb destination used duckdb:/fermion.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline fermion_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 get_user_detailed_analytics_data and get_live_event_session_stats from the Fermion 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 fermion_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://backend.codedamn.com/api", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "get_user_detailed_analytics_data", "endpoint": {"path": "api/public/get-user-detailed-analytics-data"}}, {"name": "get_live_event_session_stats", "endpoint": {"path": "api/public/get-live-event-session-stats"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="fermion_pipeline", destination="duckdb", dataset_name="fermion_data", ) load_info = pipeline.run(fermion_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("fermion_pipeline").dataset() sessions_df = data.get_live_event_session_stats.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM fermion_data.get_live_event_session_stats LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("fermion_pipeline").dataset() data.get_live_event_session_stats.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 Fermion data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example 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 Fermion?
Request dlt skills, commands, AGENT.md files, and AI-native context.