Open Library APIs

https://openlibrary.org/developers/api
Admin
Open Library provides a suite of RESTful APIs for developers to access and utilize its extensive...
Tokens:2,950
Snippets:24
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Loading Open Library Data Dumps into PostgreSQL

Source: https://openlibrary.org/developers/api/dumps

A guide on how to load Open Library's data dumps into a PostgreSQL database for easier querying. This resource provides practical steps and code examples for data integration.

```APIDOC
PostgreSQLDataLoadingGuide:
  Title: How to load Open Library's data dumps into PostgreSQL
  Author: LibrariesHacked contributor
  Repository: https://github.com/LibrariesHacked/openlibrary-search
  Purpose: To make Open Library data more easily queriable by leveraging PostgreSQL.
  Content: Provides instructions and potential code snippets for data import and querying.
```

--------------------------------

### User-Agent Header Examples

Source: https://openlibrary.org/developers/api/api

When making frequent API calls, it's crucial to include a User-Agent header with your application's name and contact information. This helps Open Library manage request volume and contact you if necessary.

```javascript
fetch('/api/endpoint', {
  headers: {
    'User-Agent': 'YourAppName/1.0 (your.email@example.com)'
  }
});
```

```python
import requests

headers = {
    'User-Agent': 'YourAppName/1.0 (your.email@example.com)'
}
response = requests.get('/api/endpoint', headers=headers)
```

--------------------------------

### Query Wikidata IDs with DuckDB

Source: https://openlibrary.org/developers/api/dumps

Example SQL query to extract Wikidata IDs from Open Library author data dumps using DuckDB. It reads a gzipped CSV file and filters for rows where the wikidata_id is not null.

```sql
SELECT json_extract(column4, '$.remote_ids.wikidata') as wikidata_id
FROM read_csv('ol_dump_authors_2024-07-31.txt.gz')
WHERE wikidata_id IS NOT NULL
LIMIT 100;
```

--------------------------------

### Open Library Developer Resources

Source: https://openlibrary.org/developers/api/licensing

Links to key developer resources for the Open Library project, including API documentation, client libraries, and data access.

```APIDOC
Open Library Developer Resources:

- Web API: /developers/api
  - Provides access to Open Library data and functionality.
- Client Library: https://github.com/internetarchive/openlibrary-client
  - Official client library for interacting with the Open Library API.
- Data Dumps: /data
  - Access to bulk data exports from the Open Library database.
- Source Code: https://github.com/internetarchive/openlibrary
  - Repository for the Open Library project's source code.
- Report an Issue: https://github.com/internetarchive/openlibrary/issues
  - Platform for reporting bugs and suggesting improvements.
- Writing Bots: https://github.com/internetarchive/openlibrary/wiki/Writing-Bots
  - Guidelines and information for developing automated bots for Open Library.
```

--------------------------------

### OpenAPI Sandbox Access

Source: https://openlibrary.org/developers/api/api

Access the interactive OpenAPI documentation to explore and test the Open Library APIs directly. This sandbox allows for hands-on interaction with API endpoints.

```APIDOC
OpenAPI Sandbox:
  URL: https://openlibrary.org/swagger/docs
  Description: Interactive documentation for exploring and testing Open Library APIs.
```

--------------------------------

### Client Library

Source: https://openlibrary.org/developers/api/api

A client library is available to simplify interaction with the Open Library APIs. This library abstracts away much of the direct HTTP request handling.

```APIDOC
Client Library:
  Repository: https://github.com/internetarchive/openlibrary-client
  Description: Simplifies integration with Open Library APIs.
```

--------------------------------

### Available Open Library Data Dumps

Source: https://openlibrary.org/developers/api/dumps

Lists the various data dumps provided by Open Library, including their approximate sizes and content. Links are provided for the latest versions of each dump.

```APIDOC
DataDumps:
  - Name: editions dump
    Size: ~ 9.2G
    Link: https://openlibrary.org/data/ol_dump_editions_latest.txt.gz

  - Name: works dump
    Size: ~ 2.9G
    Link: https://openlibrary.org/data/ol_dump_works_latest.txt.gz

  - Name: authors dump
    Size: ~ 0.5G
    Link: https://openlibrary.org/data/ol_dump_authors_latest.txt.gz

  - Name: all types dump
    Description: Includes editions, works, authors, redirects, etc.
    Size: ~ 12.4G
    Link: https://openlibrary.org/data/ol_dump_latest.txt.gz

  - Name: complete dump
    Description: Includes past revisions of all records.
    Size: ~ 29.6G
    Link: https://openlibrary.org/data/ol_cdump_latest.txt.gz

  - Name: ratings dump
    Description: Columns: "Work Key, Edition Key (optional), Rating, Date"
    Size: ~ 5M
    Link: https://openlibrary.org/data/ol_dump_ratings_latest.txt.gz

  - Name: reading log dump
    Description: Columns: "Work Key, Edition Key (optional), Shelf, Date"
    Size: ~ 65M
    Link: https://openlibrary.org/data/ol_dump_reading-log_latest.txt.gz

  - Name: redirects dump
    Size: ~ 50M
    Link: https://openlibrary.org/data/ol_dump_redirects_latest.txt.gz

  - Name: deletes dump
    Size: ~ 75M
    Link: https://openlibrary.org/data/ol_dump_deletes_latest.txt.gz

  - Name: lists dump
    Size: ~ 30M
    Link: https://openlibrary.org/data/ol_dump_lists_latest.txt.gz

  - Name: other dump
    Size: ~ 10M
    Link: https://openlibrary.org/data/ol_dump_other_latest.txt.gz

  - Name: covers metadata dump
    Description: Columns: "id, width, height, created"
    Size: ~ 70M
    Link: https://openlibrary.org/data/ol_dump_covers_metadata_latest.txt.gz

  - Name: wikidata dump
    Description: Wikidata records relevant to Open Library (currently only authors). Columns "Wikidata ID, JSON"
    Size: ~ 700M
    Link: https://openlibrary.org/data/ol_dump_wikidata_latest.txt.gz

Past Dumps:
  Location: https://archive.org/details/ol_exports?sort=-publicdate
```

--------------------------------

### RESTful APIs Overview

Source: https://openlibrary.org/developers/api/api

Open Library provides RESTful APIs that make data available in JSON, YAML, and RDF/XML formats. These APIs are the primary method for programmatic access to Open Library data.

```APIDOC
RESTful APIs:
  Formats: JSON, YAML, RDF/XML
  Documentation: https://openlibrary.org/dev/docs/restful_api
  Description: Primary API for accessing Open Library data programmatically.
```

--------------------------------

### Open Library Revision History

Source: https://openlibrary.org/developers/api/licensing

A log of revisions made to the Open Library licensing page, showing dates, editors, and brief descriptions of changes.

```APIDOC
Open Library Licensing Page Revisions:

- Revision 8 (June 27, 2021): Edited by Mek. Edited without comment.
- Revision 7 (March 10, 2010): Edited by Lance Arthur. Remove subnav (in macro).
- Revision 6 (March 6, 2010): Edited by brewster. Edited without comment.
- Revision 5 (November 21, 2009): Created by George. Edited without comment.
- Revision 1 (November 21, 2009): Created by George. Edited without comment.

Total revisions: 8
```

--------------------------------

### Open Library Partner (Read) API

Source: https://openlibrary.org/developers/api/api

Formerly the 'Read' API, this allows fetching one or more books using library identifiers like ISBNs, OCLC, or LCCNs.

```APIDOC
Partner API (formerly Read API):
  Description: Fetch one or more books by library identifiers (ISBNs, OCLC, LCCNs).
  Endpoint: https://openlibrary.org/dev/docs/api/read
```

--------------------------------

### Accessing Item History

Source: https://openlibrary.org/developers/api/api

Demonstrates how to access the history of an item by appending a query parameter to its page URL.

```APIDOC
Accessing Item History:
  Method: Append '?m=history' to an item's page URL.
  Example: https://openlibrary.org/authors/OL236414A.json?m=history
```

--------------------------------

### Open Library Subjects API

Source: https://openlibrary.org/developers/api/api

API to fetch books categorized under specific subject names.

```APIDOC
Subjects API:
  Description: Fetch books by subject name.
  Endpoint: /dev/docs/api/subjects
```

--------------------------------

### Open Library Lists API

Source: https://openlibrary.org/developers/api/api

API for reading, modifying, or creating user-generated reading lists.

```APIDOC
Lists API:
  Description: Reading, modifying, or creating user lists.
  Endpoint: /dev/docs/api/lists
```

--------------------------------

### Open Library Covers API

Source: https://openlibrary.org/developers/api/api

API to retrieve book cover images using ISBN or Open Library identifiers.

```APIDOC
Covers API:
  Description: Fetch book covers by ISBN or Open Library identifier.
  Endpoint: /dev/docs/api/covers
```

--------------------------------

### Deprecated JSON API

Source: https://openlibrary.org/developers/api/api

An earlier version of the JSON API is preserved for backward compatibility. Developers are encouraged to migrate to the RESTful APIs for new development.

```APIDOC
Deprecated JSON API:
  Documentation: https://openlibrary.org/dev/docs/json_api
  Note: Preserved for backward compatibility; RESTful APIs are recommended.
```

--------------------------------

### Open Library Data Dump Formats

Source: https://openlibrary.org/developers/api/dumps

Details the structure of Open Library's data dumps, which are primarily tab-separated files. Each record includes type, key, revision, last modified timestamp, and the complete record in JSON format.

```APIDOC
OpenLibraryDataDump:
  Format: Tab-separated values (TSV)
  Columns:
    - type: Type of record (e.g., /type/edition, /type/work)
    - key: Unique identifier for the record (e.g., /books/OL1M)
    - revision: Revision number of the record
    - last_modified: Timestamp of the last modification
    - JSON: The complete record serialized as a JSON string

JSONRecordSchema:
  Location: https://github.com/internetarchive/openlibrary-client/tree/master/olclient/schemata
  Types:
    - Author Records: JSON serialization of a /type/author
    - Edition Records: JSON serialization of a /type/edition
    - Work Records: JSON serialization of a /type/work
```

--------------------------------

### Open Library My Books API

Source: https://openlibrary.org/developers/api/api

API to access books listed on a patron's public reading log.

```APIDOC
My Books API:
  Description: Retrieve books on a patron's public reading log.
  Endpoint: /dev/docs/api/mybooks
```

--------------------------------

### Accessing Structured Bibliographic Data

Source: https://openlibrary.org/developers/api/api

Shows how to retrieve structured bibliographic data (RDF, JSON, YAML) by changing the file extension of an Open Library identifier.

```APIDOC
Accessing Structured Bibliographic Data:
  Method: Append '.rdf', '.json', or '.yml' to an identifier.
  Examples:
    - https://openlibrary.org/works/OL15626917W.json
    - https://openlibrary.org/authors/OL33421A.json
```

--------------------------------

### Open Library Recent Changes API

Source: https://openlibrary.org/developers/api/api

Provides programmatic access to track changes made across the Open Library platform.

```APIDOC
Recent Changes API:
  Description: Programmatic access to changes across Open Library.
  Endpoint: /dev/docs/api/recentchanges
```

--------------------------------

### Open Library Licensing Statement

Source: https://openlibrary.org/developers/api/licensing

The official statement regarding copyright and proprietary rights over the Open Library database content.

```APIDOC
Open Library Licensing:

Statement: The Internet Archive does not assert any new copyright or other proprietary rights over any of the material in the Open Library database.

Caveats:
- Existing rights issues may apply to some contributions and in some jurisdictions.
- Legal issues surrounding community projects are complex.

Goal: To create a database that can be openly used for a wide variety of purposes.

Appreciation: Acknowledges and appreciates all contributors.
```

--------------------------------

### Open Library Book Search API

Source: https://openlibrary.org/developers/api/api

Provides API endpoints for searching books, authors, and other related entities within the Open Library catalog.

```APIDOC
Book Search API:
  Description: Search results for books, authors, and more.
  Endpoint: /dev/docs/api/search
```

--------------------------------

### Open Library Work & Edition APIs

Source: https://openlibrary.org/developers/api/api

API endpoints for retrieving specific book works or editions by their unique identifiers.

```APIDOC
Work & Edition APIs:
  Description: Retrieve a specific work or edition by identifier.
  Endpoint: /dev/docs/api/books
```

--------------------------------

### Open Library Search Inside API

Source: https://openlibrary.org/developers/api/api

API for searching for specific text content within millions of digitized books.

```APIDOC
Search inside API:
  Description: Search for matching text within millions of books.
  Endpoint: /dev/docs/api/search_inside
```

--------------------------------

### Open Library Authors API

Source: https://openlibrary.org/developers/api/api

API for retrieving author information and their associated works using author identifiers.

```APIDOC
Authors API:
  Description: Retrieve an author and their works by author identifier.
  Endpoint: /dev/docs/api/authors
```
Tokens:
Raw