Aller au contenu
Hardcover

Searching for content in the API

Last updated on November 13, 2024

Guide

What can I search for?

Currently, you can search for authors, books, characters, lists, prompts, publishers, series, and users. Additional search options will be added in the future.

Search options

  • query - The search term
  • query_type - The type of content to search for one of (case-insensitive; default book)
    • author
    • book
    • character
    • list
    • prompt
    • publisher
    • series
    • user
  • per_page - The number of results to return per page (default 25)
  • page - The page number to return (default 1)

Available fields

  • id
  • results

Example searches

Authors

When searching authors, we use the following fields:

  • alternate_names - Alternative names for the author
  • books - A list of books written by the author
  • name - The name of the author
  • name_personal - The personal name of the author
  • series_names - The names of the different series the author has written
Search Authors
  query BooksByRowling {
      search(
          query: "rowling",
          query_type: "Author",
          per_page: 5,
          page: 1
      ) {
          results
      }
  }

Books

When searching books, we use the following fields:

  • alternative_titles - Alternative titles for the book
  • author_names - The name of the authors or contributors of the book
  • isbns - The ISBNs of the book
  • series_names - The name of the series the book belongs to
  • title - The title of the book
Search books
  query LordOfTheRingsBooks {
      search(
          query: "lord of the rings",
          query_type: "Book",
          per_page: 5,
          page: 1
      ) {
          results
      }
  }

Characters

When searching characters, we use the following fields:

  • author_names - The name of the author who wrote the books the character appears in
  • books - A list of books the character appears in
  • name - The name of the character
Search characters
  query CharactersNamedPeter {
      search(
          query: "peter",
          query_type: "Character",
          per_page: 5,
          page: 1
      ) {
          results
      }
  }

Lists

When searching lists, we use the following fields:

  • description - The description of the list
  • books - A list of books in the list
  • name - The name of the list
Search lists
  query ListsNamedBest {
      search(
          query: "best",
          query_type: "List",
          per_page: 5,
          page: 1
      ) {
          results
      }
  }

Prompts

When searching prompts, we use the following fields:

  • books - A list of books for the matching prompt
  • question - The prompt question
Search prompts
  query PromptsAboutLearning {
      search(
          query: "learn from",
          query_type: "Prompt",
          per_page: 5,
          page: 1
      ) {
          results
      }
  }

Publishers

When searching publishers, we use the following fields:

  • name - The name of the publisher
Search publishers
  query PublishersNamedPenguin {
      search(
          query: "penguin",
          query_type: "Publisher",
          per_page: 5,
          page: 1
      ) {
          results
      }
  }

Series

When searching series, we use the following fields:

  • author_name - The name of the author who wrote the series
  • books - A list of books in the series
  • name - The name of the series
Search series
  query SeriesNamedHarryPotter {
      search(
          query: "harry potter",
          query_type: "Series",
          per_page: 7,
          page: 1
      ) {
          results
      }
  }

Users

When searching users, we use the following fields:

  • location - The location of the user
  • name - The name of the user
  • username - The username of the user
Search users
  query UsersNamedAdam {
      search(
          query: "adam",
          query_type: "User",
          per_page: 5,
          page: 1
      ) {
          results
      }
  }