ERCOT Python API Docs | dltHub
Build a ERCOT-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
ERCOT's REST API requires a valid Subscription Key and an ID Token for authentication. The ID Token is added to the "authorization" header as "Bearer". The Subscription Key is included in the "Ocp-Apim-Subscription-Key" header. The REST API base URL is https://api.ercot.com and All requests require a Bearer ID token in the Authorization header and an Ocp-Apim-Subscription-Key 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 ERCOT data in under 10 minutes.
What data can I load from ERCOT?
Here are some of the endpoints you can load from ERCOT:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| public_reports | /api/public-reports | GET | Returns a list of public reports. | |
| public_report_artifacts | /api/public-report/{productId}/artifacts | GET | items | Returns artifacts for a specific product. |
| public_report_artifact_details | /api/public-report/{productId}/artifacts/{artifactId} | GET | Returns details for a specific artifact. | |
| public_report_artifact_download | /api/public-report/{productId}/artifact/{artifactId}/download | GET | Downloads a specific artifact. | |
| public_reports_history | /api/public-reports/history | GET | Returns historical public reports. |
How do I authenticate with the ERCOT API?
Authentication uses OAuth2 ROPC to obtain an ID token (id_token) and requires a subscription key. All requests must include 'Authorization: Bearer <id_token>' and 'Ocp-Apim-Subscription-Key: <subscription_key>' in the headers.
1. Get your credentials
- Sign up / sign in at https://apiexplorer.ercot.com; 2) On Products, subscribe to Public API and copy the Primary key (Ocp-Apim-Subscription-Key); 3) Obtain an ID token via POST to the token endpoint (ROPC) with username/password as documented; 4) Use the id_token and subscription key in request headers.
2. Add them to .dlt/secrets.toml
[sources.ercot_api_source] ocp_apim_subscription_key = "your_subscription_key" id_token = "your_id_token"
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 ERCOT 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 ercot_api_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline ercot_api_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset ercot_api_data The duckdb destination used duckdb:/ercot_api.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline ercot_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 public_reports and public-report from the ERCOT 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 ercot_api_source(subscription_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.ercot.com", "auth": { "type": "bearer", "id_token": subscription_key, }, }, "resources": [ {"name": "public_reports", "endpoint": {"path": "api/public-reports"}}, {"name": "public_report_artifacts", "endpoint": {"path": "api/public-report/{productId}/artifacts", "data_selector": "items"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="ercot_api_pipeline", destination="duckdb", dataset_name="ercot_api_data", ) load_info = pipeline.run(ercot_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("ercot_api_pipeline").dataset() sessions_df = data.public_reports.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM ercot_api_data.public_reports LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("ercot_api_pipeline").dataset() data.public_reports.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 ERCOT 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 ERCOT?
Request dlt skills, commands, AGENT.md files, and AI-native context.