Books API v1

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 volumes

3 Resources

procedure
(books-volumes-list #:q q
[ #:filter filter
#:printType printType
#:showPreorders showPreorders
#:partner partner
#:download download
#:langRestrict langRestrict
#:libraryRestrict libraryRestrict
#:orderBy orderBy
#:projection projection
#:startIndex startIndex
#:maxResults maxResults
#:source source
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  q : string?
  filter : string? = 'N/A
  printType : string? = 'N/A
  showPreorders : string? = 'N/A
  partner : string? = 'N/A
  download : string? = 'N/A
  langRestrict : string? = 'N/A
  libraryRestrict : string? = 'N/A
  orderBy : string? = 'N/A
  projection : string? = 'N/A
  startIndex : string? = 'N/A
  maxResults : string? = 'N/A
  source : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Performs a book search.

q: Full-text search query string.

filter: Filter search results.

printType: Restrict to books or magazines.

showPreorders: Set to true to show books available for preorder. Defaults to false.

partner: Restrict and brand results for partner ID.

download: Restrict to volumes by download availability.

langRestrict: Restrict results to books with this language code.

libraryRestrict: Restrict search to this user’s library.

orderBy: Sort search results.

projection: Restrict information returned to a set of selected fields.

startIndex: Index of the first result to return (starts at 0)

maxResults: Maximum number of results to return.

source: String to identify the originator of this request.

procedure
(books-volumes-get #:volumeId volumeId
[ #:partner partner
#:projection projection
#:country country
#:source source
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  volumeId : string?
  partner : string? = 'N/A
  projection : string? = 'N/A
  country : string? = 'N/A
  source : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Gets volume information for a single volume.

volumeId: ID of volume to retrieve.

partner: Brand results for partner ID.

projection: Restrict information returned to a set of selected fields.

country: ISO-3166-1 code to override the IP-based location.

source: String to identify the originator of this request.

3.1 bookshelves

4 Resources

procedure
(books-bookshelves-list #:userId userId
[ #:source source
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  userId : string?
  source : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves a list of public bookshelves for the specified user.

userId: ID of user for whom to retrieve bookshelves.

source: String to identify the originator of this request.

procedure
(books-bookshelves-get #:shelf shelf
#:userId userId
[ #:source source
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  shelf : string?
  userId : string?
  source : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves metadata for a specific bookshelf for the specified user.

shelf: ID of bookshelf to retrieve.

userId: ID of user for whom to retrieve bookshelves.

source: String to identify the originator of this request.

4.1 layers

5 Resources

procedure
(books-layers-list #:volumeId volumeId
[ #:maxResults maxResults
#:pageToken pageToken
#:contentVersion contentVersion
#:source source
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  volumeId : string?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  contentVersion : string? = 'N/A
  source : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

List the layer summaries for a volume.

volumeId: The volume to retrieve layers for.

maxResults: Maximum number of results to return

pageToken: The value of the nextToken from the previous page.

contentVersion: The content version for the requested volume.

source: String to identify the originator of this request.

procedure
(books-layers-get #:summaryId summaryId
#:volumeId volumeId
[ #:contentVersion contentVersion
#:source source
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  summaryId : string?
  volumeId : string?
  contentVersion : string? = 'N/A
  source : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Gets the layer summary for a volume.

summaryId: The ID for the layer to get the summary for.

volumeId: The volume to retrieve layers for.

contentVersion: The content version for the requested volume.

source: String to identify the originator of this request.

5.1 myconfig

procedure
(books-myconfig-releaseDownloadAccess
#:cpksver cpksver
#:volumeIds volumeIds
[ #:locale locale
#:source source
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  cpksver : string?
  volumeIds : string?
  locale : string? = 'N/A
  source : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Release downloaded content access restriction.

cpksver: The device/version ID from which to release the restriction.

volumeIds: The volume(s) to release restrictions for.

locale: ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

source: String to identify the originator of this request.

procedure
(books-myconfig-requestAccess #:cpksver cpksver
#:volumeId volumeId
#:source source
#:nonce nonce
[ #:locale locale
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  cpksver : string?
  volumeId : string?
  source : string?
  nonce : string?
  locale : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Request concurrent and download access restrictions.

cpksver: The device/version ID from which to request the restrictions.

volumeId: The volume to request concurrent/download restrictions for.

source: String to identify the originator of this request.

nonce: The client nonce value.

locale: ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

procedure
(books-myconfig-syncVolumeLicenses
#:cpksver cpksver
#:source source
#:nonce nonce
[ #:showPreorders showPreorders
#:volumeIds volumeIds
#:locale locale
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  cpksver : string?
  source : string?
  nonce : string?
  showPreorders : string? = 'N/A
  volumeIds : string? = 'N/A
  locale : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Request downloaded content access for specified volumes on the My eBooks shelf.

cpksver: The device/version ID from which to release the restriction.

source: String to identify the originator of this request.

nonce: The client nonce value.

showPreorders: Set to true to show pre-ordered books. Defaults to false.

volumeIds: The volume(s) to request download restrictions for.

locale: ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

1	API Parameters
2	Resources
3	Resources
4	Resources
5	Resources
6	Resources