Ensembl REST Python API Docs | dltHub

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

Last updated:

Ensembl is a comprehensive genome browser and data platform that provides RESTful access to genomic, proteomic, and comparative biology data across multiple species. The REST API base URL is https://rest.ensembl.org and no authentication required.

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


What data can I load from Ensembl REST?

Here are some of the endpoints you can load from Ensembl REST:

ResourceEndpointMethodData selectorDescription
info_restinfo/restGETShows the current version of the Ensembl REST API.
info_softwareinfo/softwareGETShows the current version of the Ensembl API used by the REST server.
lookup_idlookup/id/
GETFind the species and database for a single identifier e.g. gene, transcript, protein.
archive_idarchive/id/
GETUses the given identifier to return its latest version.
ga4gh_features_searchga4gh/features/searchPOSTfeaturesReturn a list of sequence annotation features in GA4GH format.
ga4gh_datasets_searchga4gh/datasets/searchPOSTdatasetsReturn a list of datasets in GA4GH format.

How do I authenticate with the Ensembl REST API?

The Ensembl REST API does not require authentication for public access.

No credentials required. The Ensembl REST API is public, so there is nothing to obtain and nothing to add to .dlt/secrets.toml — the pipeline above runs as written.


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 Ensembl REST 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 ensembl_rest_pipeline.py

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

Pipeline ensembl_rest_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset ensembl_rest_data The duckdb destination used duckdb:/ensembl_rest.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 info/ping and lookup/id from the Ensembl REST 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 ensembl_rest_source(): config: RESTAPIConfig = { "client": { "base_url": "https://rest.ensembl.org", }, "resources": [ {"name": "ga4gh_features_search", "endpoint": {"path": "ga4gh/features/search"}}, {"name": "ga4gh_datasets_search", "endpoint": {"path": "ga4gh/datasets/search"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="ensembl_rest_pipeline", destination="duckdb", dataset_name="ensembl_rest_data", ) load_info = pipeline.run(ensembl_rest_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("ensembl_rest_pipeline").dataset() sessions_df = data.lookup_id.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM ensembl_rest_data.lookup_id LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("ensembl_rest_pipeline").dataset() data.lookup_id.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 Ensembl REST 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 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 Ensembl REST?

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

Available Pipelines