Open Library Python API Docs | dltHub

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

Last updated:

Open Library provides a suite of APIs for accessing bibliographic data and managing user content like reading logs and lists. The REST API base URL is https://openlibrary.org and most requests are unauthenticated, but write operations use cookie-based session authentication.

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


What data can I load from Open Library?

Here are some of the endpoints you can load from Open Library:

ResourceEndpointMethodData selectorDescription
search/search.jsonGETdocsSolr-backed search across the catalog
query/query.jsonGETQuery for objects matching parameters
recent_changes/recentchanges.jsonGETFetch recent modifications to objects
works/works/{olid}.jsonGETRetrieve work details by Open Library ID
authors/authors/{olid}.jsonGETRetrieve author details by Open Library ID

How do I authenticate with the Open Library API?

Read-only operations do not require authentication. For write operations (e.g., editing records), authentication is performed via a POST request to /account/login.json with S3 access and secret keys, which returns a session cookie that must be included in subsequent request headers.

1. Get your credentials

Most Open Library endpoints are public and do not require authentication. If you need to perform write/account-specific actions, you must use your Internet Archive S3 credentials. To obtain these, log in to your account at https://archive.org/ and visit https://archive.org/account/s3.php to retrieve your access and secret keys. These keys are then used to programmatically authenticate by sending a POST request to https://openlibrary.org/account/login with the JSON payload {"access": "YOUR_ACCESS_KEY", "secret": "YOUR_SECRET_KEY"} to receive a session cookie.

2. Add them to .dlt/secrets.toml

[sources.open_library_source] # No credentials are required for public GET endpoints. # If performing authorized actions, do not hardcode keys; # store them as environment variables or dlt secrets. api_access_key = "your_s3_access_key_here" api_secret_key = "your_s3_secret_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 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 Open Library 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 open_library_pipeline.py

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

Pipeline open_library_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset open_library_data The duckdb destination used duckdb:/open_library.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 search.json and works/{work_id}.json from the Open Library 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 open_library_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://openlibrary.org", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key}, }, "resources": [ {"name": "search", "endpoint": {"path": "search.json", "data_selector": "docs"}}, {"name": "query", "endpoint": {"path": "query.json"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="open_library_pipeline", destination="duckdb", dataset_name="open_library_data", ) load_info = pipeline.run(open_library_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("open_library_pipeline").dataset() sessions_df = data.search.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM open_library_data.search LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("open_library_pipeline").dataset() data.search.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 Open Library 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 Open Library?

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

Available Pipelines