athenahealth Python API Docs | dltHub
Build a athenahealth-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.
Last updated:
athenahealth’s athenaOne REST APIs let applications read, write, and update athenaOne data. The REST API base URL is https://api.platform.athenahealth.com/v1 and OAuth 2.0 access token sent as a Bearer token.
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 athenahealth data in under 10 minutes.
What data can I load from athenahealth?
Here are some of the endpoints you can load from athenahealth:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| practice_info | {practiceid}/practiceinfo | GET | practiceinfo | List of practices and athena-products enabled for the user; supports limit (default 1500, max 5000) and offset paging with next/previous/totalcount |
| departments | {practiceid}/departments | GET | departments | List of departments for the practice; response includes totalcount and departments array |
| patients | {practiceid}/patients | GET | patients | Search patients (requires firstname, lastname, dob, or homephone); response includes totalcount, next, and patients array; supports limit/offset |
| appointments | {practiceid}/appointments | GET | appointments | Search appointments by departmentid, startdate, enddate; response includes appointments array with next/totalcount paging |
| providers | {practiceid}/providers | GET | providers | List of providers (practitioners) for the practice |
| appointment_types | {practiceid}/appointmenttypes | GET | appointmenttypes | List of appointment types |
| ob_episodes | {practiceid}/chart/{patientid}/obepisodes | GET | obepisodes | Get patient's list of OB episodes (requires departmentid) |
| ping | {practiceid}/ping | GET | Verify access to a practice; returns pong boolean |
How do I authenticate with the athenahealth API?
Obtain an OAuth 2.0 access token from https://api.platform.athenahealth.com/oauth2/v1/token; for 2-legged client-credentials authentication, submit grant_type=client_credentials and authenticate the token request with the client ID and secret using HTTP Basic authentication. For API calls, send Authorization: Bearer <access_token>; the access token is a JWT and token_type is Bearer.
1. Get your credentials
- Go to the athenahealth Developer Portal at https://developer.api.athena.io/ams-portal/ and sign in (or create a developer account with your email; a Microsoft service handles account creation and sign-in). 2. On the developer console / My applications screen, click "+ Create a New App" (or "Create a new app"). 3. Fill in the application details: choose the API access type (e.g., "My app will use 1+ non-Certified APIs" or Certified APIs only), select "2-Legged OAuth" for system-to-system (backend) authentication, and provide the application name, description, and contact information as requested. 4. In the authentication section, select "Secret" (client secret) as the authentication method. 5. After creating the app, the portal displays your Client ID and Client Secret — copy both using the Copy icons and save them securely (the secret is masked if you navigate away; you can regenerate it by selecting the copy icon again). 6. If you plan to use non-Certified APIs, submit the Technical Request Form (available under your app's "Use Cases" tab) for expanded API access; production credentials are issued separately after athenahealth's partner validation. 7. Also note your Practice ID (shown in athenaNet next to your practice name, or in the browser address bar), since nearly every API endpoint is scoped to a practice.
2. Add them to .dlt/secrets.toml
[sources.athenahealth_source] client_id = "your_client_id_here" client_secret = "your_client_secret_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 athenahealth 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 athenahealth_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline athenahealth_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset athenahealth_data The duckdb destination used duckdb:/athenahealth.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 appointments and patients from the athenahealth 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 athenahealth_source(token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.platform.athenahealth.com/v1", "auth": {"type": "bearer", "token": token}, }, "resources": [ {"name": "patients", "endpoint": {"path": "{practiceid}/patients", "data_selector": "patients"}}, {"name": "appointments", "endpoint": {"path": "{practiceid}/appointments", "data_selector": "appointments"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="athenahealth_pipeline", destination="duckdb", dataset_name="athenahealth_data", ) load_info = pipeline.run(athenahealth_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("athenahealth_pipeline").dataset() sessions_df = data.patients.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM athenahealth_data.patients LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("athenahealth_pipeline").dataset() data.patients.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 athenahealth 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 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 athenahealth?
Request dlt skills, commands, AGENT.md files, and AI-native context.