/dev/docs/api/search
Type: /type/page
body: value: ## [Developer Center](https://openlibrary.org/developers) → [APIs](https://openlibrary.org/developers/api) → Search API

**URL:** https://openlibrary.org/search.json



<table>
    <thead>
        <tr>
            <th width=100><b>Parameter</b></th>
            <th><b>Description</b></th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <th><code>q<code></th>
            <td>The solr query. See <a href="/search/howto">Search HowTo</a> for sample queries</td>
        </tr>
        <tr>
            <th><code>fields</code></th>
            <td>

            The <a href="https://github.com/internetarchive/openlibrary/blob/b4afa14b0981ae1785c26c71908af99b879fa975/openlibrary/plugins/worksearch/schemes/works.py#L38-L91">fields</a> to get back from solr. The special value <code>*</code> may be provided to fetch all fields (however this will result in an expensive response, please use sparingly).
             <br />
            To fetch availability data from archive.org, add the special value, <code>availability</code>. Example: <a href="/search.json?q=harry%20potter&fields=*,availability&limit=1">/search.json?q=harry%20potter&fields=*,availability&limit=1</a>. This will fetch the availability data of the first item in the `ia` field.
        </tr>
        <tr>
            <th><code>sort<code></th>
            <td>You can sort the results by various facets such as <code>new</code>, <code>old</code>, <code>random</code>, or <code>key</code> (which sorts as a string, not as the number stored in the string). For a complete list of sorts facets look <a href="https://github.com/internetarchive/openlibrary/blob/b4afa14b0981ae1785c26c71908af99b879fa975/openlibrary/plugins/worksearch/schemes/works.py#L119-L153">here</a> (this link goes to a specific commit, be sure to look at the latest one for changes). The default is to sort by relevance.
        </tr>
        <tr>
            <th><code>lang<code></th>
            <td>The users language as a two letter (ISO 639-1) language code. This influences but doesn't exclude search results. For example setting this to <code>fr</code> will prefer/display the French edition of a given work, but will still match works that don't have French editions. Adding <code>language:fre</code> on the other hand to the search query <i>will</i> exclude results that don't have a French edition.
        </tr>
        <tr>
            <th><code>offset</code> / <code>limit<code></th>
            <td>Use for pagination.</td>
        </tr>
        <tr>
            <th><code>page</code> / <code>limit<code></th>
            <td>Use for pagination, with <code>limit</code> corresponding to the page size. Note <code>page</code> starts at 1.</td>
        </tr>
</table>


## Overview

The Open Library Search API is one of the most convenient and complete ways to retrieve book data on Open Library. The API:

 1. Is able to return data for **multiple** books in a single request/response 
 2. Returns both Work level information about the book (like author info, first publish year, etc), as well as Edition level information (like title, identifiers, covers, etc)
 3. Author IDs are returned which you can use to fetch the author's image, if available
 4. Options are available to return Book Availability along with the response.
 5. Powerful sorting options are available, such as star ratings, publication date, and number of editions.

## Examples

The URL format for API is simple. Take the search URL and add `.json` to the end. Eg:

 * https://openlibrary.org/search.json?q=the+lord+of+the+rings
 * https://openlibrary.org/search.json?title=the+lord+of+the+rings
 * https://openlibrary.org/search.json?author=tolkien&sort=new
 * https://openlibrary.org/search.json?q=the+lord+of+the+rings&page=2
 * https://openlibrary.org/search/authors.json?q=twain

## Using Thing IDs to get Images

You can use the `olid` (Open Library ID) for authors and books to fetch covers by olid, e.g.:
https://covers.openlibrary.org/a/olid/OL23919A-M.jpg



## Response Format

The response with be of the following format.

    {
        "start": 0,
        "num_found": 629,
        "docs": [
            {...},
            {...},
            ...
            {...}]
    }                

Each document specified listed in "docs" will be of the following format:
                
    {
        "cover_i": 258027,
        "has_fulltext": true,
        "edition_count": 120,
        "title": "The Lord of the Rings",
        "author_name": [
            "J. R. R. Tolkien"
        ],
        "first_publish_year": 1954,
        "key": "OL27448W",
        "ia": [
            "returnofking00tolk_1",
            "lordofrings00tolk_1",
            "lordofrings00tolk_0",
        ],
        "author_key": [
            "OL26320A"
        ],
        "public_scan_b": true
    }

The fields in the doc are described by Solr schema which can be found here:
https://github.com/internetarchive/openlibrary/blob/b4afa14b0981ae1785c26c71908af99b879fa975/openlibrary/plugins/worksearch/schemes/works.py#L38-L91

The schema is not guaranteed to be stable, but most common fields (e.g. title, IA ids, etc) should be safe to depend on.

## Getting edition information

By default, the search endpoint returns _works_ instead of _editions_. A **work** is a collection of editions; for example there is only one work for [_The Wonderful Wizard of Oz_ (OL18417W)](https://openlibrary.org/books/OL7170815M/The_Wonderful_Wizard_of_Oz), but there are 1029 editions, over many languages! Sometimes you might want to fetch data about editions as well as works. That is what the `editions` field is for:

https://openlibrary.org/search.json?q=crime+and+punishment&fields=key,title,author_name,editions


    {
        "numFound": 2421,
        "start": 0,
        "numFoundExact": true,
        "docs": [
            {
                "key": "/works/OL166894W",
                "title": "Преступление и наказание",
                "author_name": ["Фёдор Михайлович Достоевский"],
                "editions": {
                    "numFound": 290,
                    "start": 0,
                    "numFoundExact": true,
                    "docs": [
                        {
                            "key": "/books/OL37239326M",
                            "title": "Crime and Punishment"
                        }
                    ]
                }
            },
        ...

The `editions` sub-object contains the editions of this work that match the user's query (here, "crime and punishment"), sorted so the best (i.e. most relevant) is at the top. Matching editions are first selected by forwarding any search fields in the query that apply to editions (e.g. `publisher`, `language`, `ebook_access`, `has_fulltext`, etc). Any un-fielded search terms (e.g. "crime and punishment", above) are also applied, but are not require to all match.

From these, relevance is further determined by boosting books that (1) match the user's language, (2) are readable, (3) have a cover.

You can see this in action in the search UI as well. Consider the following searches:

- ["sherlock holmes"](https://openlibrary.org/search?q=sherlock+holmes&mode=everything) - The first work is OL262463W, with the edition displayed [_Memoirs of Sherlock Holmes_ (OL7058607M)](/books/OL7058607M). This edition was selected because it matched the user's query, and it matched the user's language (my language is English), and because it was readable.
- ["sherlock holmes language:fre"](https://openlibrary.org/search?q=sherlock+holmes+language%3Afre&mode=everything) - The same work is displayed as above, but now the displayed edition is [_Souvenirs sur Sherlock Holmes_ (OL8887270M)](/books/OL8887270M), selected because the user's query requires a book in French.
- ["sherlock holmes" for a French user](https://openlibrary.org/search?q=sherlock+holmes&mode=everything&lang=fr) - By setting `lang=fr` in the URL, we can simulate the website as it would appear for a French user. This information is used to influence the results again, and the displayed edition is [_Souvenirs sur Sherlock Holmes_ (OL8887270M)](/books/OL8887270M) since this matches the user's language.
- ["souvenirs sur sherlock holmes"](https://openlibrary.org/search?q=souvenirs+sur+sherlock+holmes&mode=everything) - Here as an English user, I search by the French title. So again I will see the same work as always, but the displayed edition will now also be  [_Souvenirs sur Sherlock Holmes_ (OL8887270M)](/books/OL8887270M) since this best matches the user's query.


In the API, you can also fetch fields from editions separately from those on the work, like so:

https://openlibrary.org/search.json?q=crime+and+punishment&fields=key,title,author_name,editions,editions.key,editions.title,editions.ebook_access,editions.language

    {
        "numFound": 2421,
        "start": 0,
        "numFoundExact": true,
        "docs": [
            {
                "key": "/works/OL166894W",
                "title": "Преступление и наказание",
                "author_name": ["Фёдор Михайлович Достоевский"],
                "editions": {
                    "numFound": 290,
                    "start": 0,
                    "numFoundExact": true,
                    "docs": [
                        {
                            "key": "/books/OL37239326M",
                            "title": "Crime and Punishment",
                            "language": [
                                "eng"
                            ],
                            "ebook_access": "public"
                        }
                    ]
                }
            },
        ...

Notes:
- Currently only one edition is displayed ; we are planning to add support for pagination so you can specify `editions.row` or `editions.start`.
- You can add `&editions.sort` to override the default relevance logic and instead sort by a specific field.
- You can see the exact boosting logic in the code here: https://github.com/internetarchive/openlibrary/blob/dc49fddb78a3cb25138922790ddd6a5dd2b5741c/openlibrary/plugins/worksearch/schemes/works.py#L439-L448
title: Search API
m: edit