Volume: list
Stay organized with collections
Save and categorize content based on your preferences.
Performs a book search.
Try it now.
Request
HTTP Request
GET https://www.googleapis.com/books/v1/volumes?q={search terms}
Parameters
| Parameter Name |
Value |
Description |
| Required Parameters |
q |
string |
Full-text search query string.
|
| Optional Parameters |
download |
string |
Restrict to volumes by download availability.
Acceptable values are:
- "
epub" - All volumes with epub.
|
filter |
string |
Filter search results.
Acceptable values are:
- "
ebooks" - All Google eBooks.
- "
free-ebooks" - Google eBook with full volume text viewability.
- "
full" - Public can view entire volume text.
- "
paid-ebooks" - Google eBook with a price.
- "
partial" - Public able to see parts of text.
|
langRestrict |
string |
Restrict results to books with this language code.
|
libraryRestrict |
string |
Restrict search to this user's library.
Acceptable values are:
- "
my-library" - Restrict to the user's library, any shelf.
- "
no-restrict" - Do not restrict based on user's library.
|
maxResults |
unsigned integer |
Maximum number of results to return.
Acceptable values are 0 to 40, inclusive.
|
orderBy |
string |
Sort search results.
Acceptable values are:
- "
newest" - Most recently published.
- "
relevance" - Relevance to search terms.
|
partner |
string |
Restrict and brand results for partner ID.
|
printType |
string |
Restrict to books or magazines.
Acceptable values are:
- "
all" - All volume content types.
- "
books" - Just books.
- "
magazines" - Just magazines.
|
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.
|
showPreorders |
boolean |
Set to true to show books available for preorder. Defaults to false.
|
source |
string |
String to identify the originator of this request.
|
startIndex |
unsigned integer |
Index of the first result 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",
"items": [
volume Resource
],
"totalItems": (value)
}
| Property Name |
Value |
Description |
Notes |
kind |
string |
Resource type. |
|
items[] |
list |
A list of volumes. |
|
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. |
|
Try It!
Use the explorer below to call this method on live data and see the response.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-06-26 UTC.
[null,null,["Last updated 2024-06-26 UTC."],[[["\u003cp\u003eSearches for books based on a provided query string.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by criteria such as availability, format, language, and publication type.\u003c/p\u003e\n"],["\u003cp\u003eOffers control over the number of results, sorting order, and specific data fields returned.\u003c/p\u003e\n"],["\u003cp\u003eCan be used to retrieve information about books, including volume details and access options.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to handle large result sets.\u003c/p\u003e\n"]]],[],null,["# Volume: list\n\nPerforms a book search.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP Request\n\n GET https://www.googleapis.com/books/v1/volumes?q={search terms}\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|-------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Required Parameters** |||\n| `q` | `string` | Full-text search query string. |\n| **Optional Parameters** |||\n| `download` | `string` | Restrict to volumes by download availability. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`epub`\" - All volumes with epub. |\n| `filter` | `string` | Filter search results. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`ebooks`\" - All Google eBooks. - \"`free-ebooks`\" - Google eBook with full volume text viewability. - \"`full`\" - Public can view entire volume text. - \"`paid-ebooks`\" - Google eBook with a price. - \"`partial`\" - Public able to see parts of text. |\n| `langRestrict` | `string` | Restrict results to books with this language code. |\n| `libraryRestrict` | `string` | Restrict search to this user's library. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`my-library`\" - Restrict to the user's library, any shelf. - \"`no-restrict`\" - Do not restrict based on user's library. |\n| `maxResults` | `unsigned integer` | Maximum number of results to return. Acceptable values are `0` to `40`, inclusive. |\n| `orderBy` | `string` | Sort search results. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`newest`\" - Most recently published. - \"`relevance`\" - Relevance to search terms. |\n| `partner` | `string` | Restrict and brand results for partner ID. |\n| `printType` | `string` | Restrict to books or magazines. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`all`\" - All volume content types. - \"`books`\" - Just books. - \"`magazines`\" - Just magazines. |\n| `projection` | `string` | Restrict information returned to a set of selected fields. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`full`\" - Includes all volume data. - \"`lite`\" - Includes a subset of fields in volumeInfo and accessInfo. |\n| `showPreorders` | `boolean` | Set to true to show books available for preorder. Defaults to false. |\n| `source` | `string` | String to identify the originator of this request. |\n| `startIndex` | `unsigned integer` | Index of the first result to return (starts at 0) |\n\n### Request Body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n {\n \"kind\": \"books#volumes\",\n \"items\": [\n volume Resource\n ],\n \"totalItems\": (value)\n }\n\n| Property Name | Value | Description | Notes |\n|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `kind` | `string` | Resource type. | |\n| `items[]` | `list` | A list of volumes. | |\n| `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. | |\n\nTry It!\n-------\n\n\nUse the explorer below to call this method on live data and see the response."]]