Open Library API
The Open Library API provides comprehensive access to library catalog data including books, authors, works, lists, and user data. Supports both public and…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Open Library API provides comprehensive access to library catalog data including books, authors, works, lists, and user data. Supports both public and authenticated endpoints with full data validation and type safety.
Endpoints 59
import
- GETImport Preview Json Get
/import/preview.jsonPreview import metadata without saving. Requires admin, librarian, or super-librarian role. - POSTImport Preview Json Post
/import/preview.jsonImport metadata, optionally saving it. Requires admin, librarian, or super-librarian role.
lists
- GETList View Json User Lists
/people/:username/lists/:list_id.jsonReturns JSON metadata for a user-owned list. Example: /people/mekBot/lists/OL123L.json - GETList View Json Public
/series/:list_id.jsonReturns JSON metadata for a public list or series. Examples: /lists/OL456L.json /series/OL789L.json - GETList View Json Public
/lists/:list_id.jsonReturns JSON metadata for a public list or series. Examples: /lists/OL456L.json /series/OL789L.json - POSTLists Delete
/people/:username/lists/:list_id/delete.jsonDelete a list owned by the given user. - POSTLists Delete No Prefix
/lists/:list_id/delete.jsonDelete a list (legacy path without username prefix). - GETLists Json People
/people/:username/lists.json - POSTLists Json Post
/people/:username/lists.json - GETLists Json Books
/books/OL:edition_idM/lists.json - GETLists Json Works
/works/OL:work_idW/lists.json - GETLists Json Authors
/authors/OL:author_idA/lists.json - GETLists Json Subjects
/subjects/:subject_key/lists.json - GETList Seeds Json User
/people/:username/lists/:olid/seeds.json - POSTUpdate List Seeds Json User
/people/:username/lists/:olid/seeds.json - GETSeries Seeds Json User
/people/:username/series/:olid/seeds.json - POSTUpdate Series Seeds Json User
/people/:username/series/:olid/seeds.json - GETList Seeds Json Public
/lists/:olid/seeds.json - POSTUpdate List Seeds Json Public
/lists/:olid/seeds.json - GETSeries Seeds Json Public
/series/:olid/seeds.json - POSTUpdate Series Seeds Json Public
/series/:olid/seeds.json - GETList Editions Json
/lists/:olid/editions.jsonGet paginated editions for a public list. - GETList Editions Json People
/people/:username/lists/:olid/editions.jsonGet paginated editions for a specific user's list. - GETSeries Editions Json
/series/:olid/editions.jsonGet paginated editions for a specific series. - GETList Subjects Json User
/people/:username/lists/:olid/subjects.json - GETList Subjects Json Public
/lists/:olid/subjects.json - GETList Subjects Json Series
/series/:olid/subjects.json
merge-authors
- POSTMerge Authors Json
/authors/merge.json
search
- GETSearch Json
/search.jsonPerforms a search for documents based on the provided query. - GETSearch Editions Json
/search/editions.jsonSearch for edition documents in the Solr index. Supports full-text search across edition fields (title, ISBN, publisher, etc.) and optional filtering by work…
- GETHealth
/health - GETAccount Loans Json
/account/loans.json - GETAccount Loan History Json
/account/loan-history.json - POSTLogin
/account/loginLogin endpoint - works identically to web.py version. This endpoint: 1. Validates email/password against Internet Archive 2. Creates/links OpenLibrary account… - POSTLogout
/account/logoutLogout endpoint - clears authentication cookies. This mirrors the web.py logout functionality. - GETGet Books
/api/books.json?bibkeys=stringGet book metadata by bibliography keys. This endpoint provides basic information about books, including URLs, thumbnail links, and preview availability.… - GETGet Volumes Multiget
/api/volumes/:brief_or_full/json/:req.jsonGet volume information for multiple identifiers. This endpoint handles multi-lookup form of Hathi-style API, allowing multiple identifiers in a single… - GETGet Volume
/api/volumes/:brief_or_full/:idtype/:idval.jsonGet volume information by identifier type and value. This endpoint provides detailed information about a specific volume, modeled after HathiTrust… - GETBorrow
/books/:olid/:slug/borrowCalled when the user wants to borrow the edition. Mirrors the legacy web.py borrow.GET/POST handler, passing fastapi=True so the interstitial render branch… - POSTBorrow
/books/:olid/:slug/borrowCalled when the user wants to borrow the edition. Mirrors the legacy web.py borrow.GET/POST handler, passing fastapi=True so the interstitial render branch… - GETCheckout With Ocaid Get
/borrow/ia/:ocaidRedirect shim: translates an IA identifier into the canonical OL /borrow URL. Mirrors the legacy web.py checkout_with_ocaid.GET, which redirects rather than… - POSTCheckout With Ocaid Post
/borrow/ia/:ocaidForwards a borrow request to the canonical /borrow route above. Mirrors the legacy web.py checkout_with_ocaid.POST, which does the same in-process (calling… - GETGraphite Graph
/cdn/graphite/:nameProxy and cache a Graphite chart for the /stats page. - GETIa Js Cdn
/cdn/archive.org/:filenameProxy Internet Archive JS files. - POSTCreate Or Update Patron Check In
/works/OL:work_idW/check-ins.jsonCreate or update a check-in event. If event_id is provided, updates existing event. Otherwise creates a new one. - POSTCreate Or Update Patron Check In
/works/OL:work_idW/check-insCreate or update a check-in event. If event_id is provided, updates existing event. Otherwise creates a new one. - DELETEDelete Patron Check In
/check-ins/:check_in_idDelete a check-in event by ID. The user can only delete their own check-in events. Returns 200 OK with empty body on success (matching web.py behavior). - GETList Languages
/languages.jsonGet a list of the top languages, sorted by the specified criteria. - GETGet Public My Books Json
/people/:username/books/:key.jsonGet public reading log for a user. Returns the user's reading log if: 1. The user's readlog is public (preferences.public_readlog == 'yes') 2. The requesting… - GETPublisher Json
/publishers/:key.json - GETSearch Inside Json
/search/inside.json?q=string - GETSearch Subjects Json
/search/subjects.json - GETSearch Lists Json
/search/lists.json - GETSearch Authors Json
/search/authors.json - GETTasks Series
/stats/tasks.jsonThe counts behind /stats/tasks as aligned daily series, one entry per calendar day whether or not it was gathered. - GETSubject Json
/subjects/:key.json - GETTasks Feed
/tasks/feed.jsonRecent human edits to catalog records as rows for the Tasks page feed, rotated and restamped back from now. - GETGet Reading Goals Endpoint
/reading-goal.jsonGet reading goals for the authenticated user. - POSTUpdate Reading Goal Endpoint
/reading-goal.jsonCreate or update a reading goal, or delete it when goal is 0.
API details
- Authentication
- An API key in the session cookie
- Operations
- 59 operations on 50 pathsGET 42POST 16DELETE 1
- Main resources
- lists 25import 2search 2merge-authors 1
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- OpenAPI document · Support
- Listed from
- Openlibrary's published OpenAPI description
How to test the Open Library API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Open Library API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the session cookie. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Import Preview Json Get” (GET /import/preview.json), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Open Library API?
The Open Library API provides comprehensive access to library catalog data including books, authors, works, lists, and user data. Supports both public and… It is listed under Media & content and has 59 endpoints.
Who publishes the Open Library API?
It is listed from Openlibrary's public API description (an OpenAPI document), not published by Openlibrary on Swastik Codes. Anyone who controls openlibrary.org can claim the profile by adding a DNS TXT record.
How do I authenticate with the Open Library API?
With an API key in the session cookie.
How many endpoints does the Open Library API have?
59 operations on 50 paths (42 GET, 16 POST, 1 DELETE). The largest groups are lists, import, search, merge-authors.
Is forking the Open Library API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.