Mylibrary.bookshelves.volumes: list

  • The API method mylibrary.bookshelves.volumes.list retrieves volume information for volumes on a bookshelf.

  • The HTTP request uses a GET method with the URL https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes.

  • A required parameter shelf specifies the bookshelf ID or name, while optional parameters include maxResults, projection, q, showPreorders, source, and startIndex.

  • The response includes the kind of resource, the total number of items found in totalItems, and a list of volumes in items.

Gets volume information for volumes on a bookshelf. Try it now.

Request

HTTP Request

GET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes

Parameters

Parameter Name Value Description
Required Parameters
shelf string The bookshelf ID or name retrieve volumes for.
Optional Parameters
maxResults unsigned integer Maximum number of results to return
projection string Restrict information returned to a set of selected fields.

Acceptable values are:
  • "full" - Includes all volume data.
  • "lite" - Includes a subset of fields in volumeInfo and accessInfo.
q string Full-text search query string in this bookshelf.
showPreorders boolean Set to true to show pre-ordered books. Defaults to false.
source string String to identify the originator of this request.
startIndex unsigned integer Index of the first element to return (starts at 0)

Request Body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "books#volumes",
  "totalItems": integer,
  "items": [
    volumes Resource
  ]
}
Property Name Value Description Notes
kind string Resource type.
totalItems integer Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
items[] list A list of volumes.

Try It!

Use the explorer below to call this method on live data and see the response.