Google

Books API

The Google Books API allows clients to access the Google Books repository.

Media & content#openapi#analytics#media

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 Google Books API allows clients to access the Google Books repository.

Endpoints 51

bookshelves

  • GETRetrieves metadata for a specific bookshelf for the specified user./books/v1/users/:userId/bookshelves/:shelf?source=stringRetrieves metadata for a specific bookshelf for the specified user.
  • GETRetrieves a list of public bookshelves for the specified user./books/v1/users/:userId/bookshelves?source=stringRetrieves a list of public bookshelves for the specified user.

bookshelves.volumes

  • GETRetrieves volumes in a specific bookshelf for the specified user./books/v1/users/:userId/bookshelves/:shelf/volumes?maxResults=0&showPreorders=true&source=string&startIndex=0Retrieves volumes in a specific bookshelf for the specified user.

cloudloading

  • POSTAdd a user-upload volume and triggers processing./books/v1/cloudloading/addBook?drive_document_id=string&mime_type=string&name=string&upload_client_token=stringAdd a user-upload volume and triggers processing.
  • POSTRemove the book and its contents/books/v1/cloudloading/deleteBook?volumeId=stringRemove the book and its contents
  • POSTUpdates a user-upload volume./books/v1/cloudloading/updateBookUpdates a user-upload volume.

dictionary

  • GETReturns a list of offline dictionary metadata available/books/v1/dictionary/listOfflineMetadata?cpksver=stringReturns a list of offline dictionary metadata available

familysharing

  • GETGets information regarding the family that the user is part of./books/v1/familysharing/getFamilyInfo?source=stringGets information regarding the family that the user is part of.
  • POSTInitiates sharing of the content with the user's family/books/v1/familysharing/share?docId=string&source=string&volumeId=stringInitiates sharing of the content with the user's family. Empty response indicates success.
  • POSTInitiates revoking content that has already been shared with the user's family/books/v1/familysharing/unshare?docId=string&source=string&volumeId=stringInitiates revoking content that has already been shared with the user's family. Empty response indicates success.

layers

  • GETGets the layer summary for a volume./books/v1/volumes/:volumeId/layersummary/:summaryId?contentVersion=string&source=stringGets the layer summary for a volume.
  • GETList the layer summaries for a volume./books/v1/volumes/:volumeId/layersummary?contentVersion=string&maxResults=0&pageToken=string&source=stringList the layer summaries for a volume.

layers.annotationData

  • GETGets the annotation data./books/v1/volumes/:volumeId/layers/:layerId/data/:annotationDataId?allowWebDefinitions=true&contentVersion=string&h=0&locale=string&scale=0&source=string&w=0Gets the annotation data.
  • GETGets the annotation data for a volume and layer./books/v1/volumes/:volumeId/layers/:layerId/data?annotationDataId=string&contentVersion=string&h=0&locale=string&maxResults=0&pageToken=string&scale=0&source=string&updatedMax=string&updatedMin=string&w=0Gets the annotation data for a volume and layer.

layers.volumeAnnotations

  • GETGets the volume annotation./books/v1/volumes/:volumeId/layers/:layerId/annotations/:annotationId?locale=string&source=stringGets the volume annotation.
  • GETGets the volume annotations for a volume and layer./books/v1/volumes/:volumeId/layers/:layerId?contentVersion=string&endOffset=string&endPosition=string&locale=string&maxResults=0&pageToken=string&showDeleted=true&source=string&startOffset=string&startPosition=string&updatedMax=string&updatedMin=string&volumeAnnotationsVersion=stringGets the volume annotations for a volume and layer.

myconfig

  • GETGets the current settings for the user./books/v1/myconfig/getUserSettings?country=stringGets the current settings for the user.
  • POSTRelease downloaded content access restriction./books/v1/myconfig/releaseDownloadAccess?cpksver=string&locale=string&source=string&volumeIds=stringRelease downloaded content access restriction.
  • POSTRequest concurrent and download access restrictions./books/v1/myconfig/requestAccess?cpksver=string&licenseTypes=LICENSE_TYPES_UNDEFINED&locale=string&nonce=string&source=string&volumeId=stringRequest concurrent and download access restrictions.
  • POSTRequest downloaded content access for specified volumes on the My eBooks shelf./books/v1/myconfig/syncVolumeLicenses?cpksver=string&features=FEATURES_UNDEFINED&includeNonComicsSeries=true&locale=string&nonce=string&showPreorders=true&source=string&volumeIds=stringRequest downloaded content access for specified volumes on the My eBooks shelf.
  • POSTSets the settings for the user/books/v1/myconfig/updateUserSettingsSets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will…

mylibrary.annotations

  • PUTUpdates an existing annotation./books/v1/mylibrary/annotations/:annotationId?source=stringUpdates an existing annotation.
  • DELETEDeletes an annotation./books/v1/mylibrary/annotations/:annotationId?source=stringDeletes an annotation.
  • GETRetrieves a list of annotations, possibly filtered./books/v1/mylibrary/annotations?contentVersion=string&layerId=string&layerIds=string&maxResults=0&pageToken=string&showDeleted=true&source=string&updatedMax=string&updatedMin=string&volumeId=stringRetrieves a list of annotations, possibly filtered.
  • POSTInserts a new annotation./books/v1/mylibrary/annotations?annotationId=string&country=string&showOnlySummaryInResponse=true&source=stringInserts a new annotation.
  • POSTGets the summary of specified layers./books/v1/mylibrary/annotations/summary?layerIds=string&source=string&volumeId=stringGets the summary of specified layers.

mylibrary.bookshelves

  • POSTAdds a volume to a bookshelf./books/v1/mylibrary/bookshelves/:shelf/addVolume?reason=REASON_UNDEFINED&source=string&volumeId=stringAdds a volume to a bookshelf.
  • POSTClears all volumes from a bookshelf./books/v1/mylibrary/bookshelves/:shelf/clearVolumes?source=stringClears all volumes from a bookshelf.
  • GETRetrieves metadata for a specific bookshelf belonging to the authenticated user./books/v1/mylibrary/bookshelves/:shelf?source=stringRetrieves metadata for a specific bookshelf belonging to the authenticated user.
  • GETRetrieves a list of bookshelves belonging to the authenticated user./books/v1/mylibrary/bookshelves?source=stringRetrieves a list of bookshelves belonging to the authenticated user.
  • POSTMoves a volume within a bookshelf./books/v1/mylibrary/bookshelves/:shelf/moveVolume?source=string&volumeId=string&volumePosition=0Moves a volume within a bookshelf.
  • POSTRemoves a volume from a bookshelf./books/v1/mylibrary/bookshelves/:shelf/removeVolume?reason=REASON_UNDEFINED&source=string&volumeId=stringRemoves a volume from a bookshelf.

mylibrary.bookshelves.volumes

  • GETGets volume information for volumes on a bookshelf./books/v1/mylibrary/bookshelves/:shelf/volumes?country=string&maxResults=0&projection=PROJECTION_UNDEFINED&q=string&showPreorders=true&source=string&startIndex=0Gets volume information for volumes on a bookshelf.

mylibrary.readingpositions

  • GETRetrieves my reading position information for a volume./books/v1/mylibrary/readingpositions/:volumeId?contentVersion=string&source=stringRetrieves my reading position information for a volume.
  • POSTSets my reading position information for a volume./books/v1/mylibrary/readingpositions/:volumeId/setPosition?action=ACTION_UNDEFINED&contentVersion=string&deviceCookie=string&position=string&source=string&timestamp=stringSets my reading position information for a volume.

notification

  • GETReturns notification details for a given notification id./books/v1/notification/get?locale=string&notification_id=string&source=stringReturns notification details for a given notification id.

onboarding

  • GETList categories for onboarding experience./books/v1/onboarding/listCategories?locale=stringList categories for onboarding experience.
  • GETList available volumes under categories for onboarding experience./books/v1/onboarding/listCategoryVolumes?categoryId=string&locale=string&maxAllowedMaturityRating=MAX_ALLOWED_MATURITY_RATING_UNDEFINED&pageSize=0&pageToken=stringList available volumes under categories for onboarding experience.

personalizedstream

  • GETReturns a stream of personalized book clusters/books/v1/personalizedstream/get?locale=string&maxAllowedMaturityRating=MAX_ALLOWED_MATURITY_RATING_UNDEFINED&source=stringReturns a stream of personalized book clusters

promooffer

  • POSTAccepts the promo offer./books/v1/promooffer/accept?androidId=string&device=string&manufacturer=string&model=string&offerId=string&product=string&serial=string&volumeId=stringAccepts the promo offer.
  • POSTMarks the promo offer as dismissed./books/v1/promooffer/dismiss?androidId=string&device=string&manufacturer=string&model=string&offerId=string&product=string&serial=stringMarks the promo offer as dismissed.
  • GETReturns a list of promo offers available to the user/books/v1/promooffer/get?androidId=string&device=string&manufacturer=string&model=string&product=string&serial=stringReturns a list of promo offers available to the user

series

  • GETReturns Series metadata for the given series ids./books/v1/series/get?series_id=stringReturns Series metadata for the given series ids.

series.membership

  • GETReturns Series membership data given the series id./books/v1/series/membership/get?page_size=0&page_token=string&series_id=stringReturns Series membership data given the series id.

volumes

  • GETGets volume information for a single volume./books/v1/volumes/:volumeId?country=string&includeNonComicsSeries=true&partner=string&projection=PROJECTION_UNDEFINED&source=string&user_library_consistent_read=trueGets volume information for a single volume.
  • GETPerforms a book search./books/v1/volumes?download=DOWNLOAD_UNDEFINED&filter=FILTER_UNDEFINED&langRestrict=string&libraryRestrict=LIBRARY_RESTRICT_UNDEFINED&maxAllowedMaturityRating=MAX_ALLOWED_MATURITY_RATING_UNDEFINED&maxResults=0&orderBy=ORDER_BY_UNDEFINED&partner=string&printType=PRINT_TYPE_UNDEFINED&projection=PROJECTION_UNDEFINED&q=string&showPreorders=true&source=string&startIndex=0Performs a book search.

volumes.associated

  • GETReturn a list of associated books./books/v1/volumes/:volumeId/associated?association=ASSOCIATION_UNDEFINED&locale=string&maxAllowedMaturityRating=MAX_ALLOWED_MATURITY_RATING_UNDEFINED&source=stringReturn a list of associated books.

volumes.mybooks

  • GETReturn a list of books in My Library./books/v1/volumes/mybooks?acquireMethod=ACQUIRE_METHOD_UNDEFINED&country=string&locale=string&maxResults=0&processingState=PROCESSING_STATE_UNDEFINED&source=string&startIndex=0Return a list of books in My Library.

volumes.recommended

  • GETReturn a list of recommended books for the current user./books/v1/volumes/recommended?locale=string&maxAllowedMaturityRating=MAX_ALLOWED_MATURITY_RATING_UNDEFINED&source=stringReturn a list of recommended books for the current user.
  • POSTRate a recommended book for the current user./books/v1/volumes/recommended/rate?locale=string&rating=RATING_UNDEFINED&source=string&volumeId=stringRate a recommended book for the current user.

volumes.useruploaded

  • GETReturn a list of books uploaded by the current user./books/v1/volumes/useruploaded?locale=string&maxResults=0&processingState=PROCESSING_STATE_UNDEFINED&source=string&startIndex=0&volumeId=stringReturn a list of books uploaded by the current user.

API details

Base URL
https://books.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
51 operations on 49 pathsGET 30POST 19PUT 1DELETE 1
Main resources
mylibrary.bookshelves 6myconfig 5mylibrary.annotations 5cloudloading 3familysharing 3promooffer 3bookshelves 2layers 2layers.annotationData 2layers.volumeAnnotations 2
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Books API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Books API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieves metadata for a specific bookshelf for the specified user.” (GET /books/v1/users/:userId/bookshelves/:shelf?source=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Books API?

The Google Books API allows clients to access the Google Books repository. It is listed under Media & content and has 51 endpoints.

Who publishes the Books API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Books API?

Requests go to https://books.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Books API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Books API have?

51 operations on 49 paths (30 GET, 19 POST, 1 PUT, 1 DELETE). The largest groups are mylibrary.bookshelves, myconfig, mylibrary.annotations, cloudloading.

Is forking the Books API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.