buzz.bookhive.getPersonalLibrary
Get the authenticated user's personal ebook library.
Details · query
| Kind | query |
|---|---|
| Authority | bookhive.buzz |
| Commit rev | 3n2mntoqgyc2e |
| Indexed |
Query
query · GETParameters
query stringcursor
stringPagination cursor
limit
integerMaximum number of books to return
minimum: 1maximum: 100default: 24
q
stringCase-insensitive substring match against title or authors. Mirrors the OPDS search feed.
minLength: 1maxLength: 256
shelfId
integerFilter by personal shelf ID
sort
stringResult ordering. `recent` is newest-added first (the default, matching the library page and the OPDS /all feed); `title` and `author` are ascending alphabetical, matching the OPDS search results feed. Not switched implicitly when `q` is set — pass it explicitly.
default: "recent"knownValues: recent | title | author
#personalBookView
objectProperties
authors
stringAuthors of the book (tab-separated)
SHA-256 hash of the file content, used as stable identifier
coverUrl
stringURL of the book cover image. When it points at the public catalog image proxy it needs no authentication; the `/library/covers/...` form is session-authenticated, so a client using service auth should use `hasLocalCover` and getPersonalBookCover instead.
When the book was added to the library
description
stringSynopsis from the linked BookHive catalog entry. Deliberately unbounded: this is scraped catalog copy, not user input, and 125 of the 367k descriptions in production already exceed 5000 bytes (longest 10386). A maxLength here would be a contract the data violates, and enforcing it would mean truncating a synopsis mid-sentence.
filename
stringOriginal uploaded file name. A sync client needs this to correlate the book with what is on the device.
File format (e.g. epub, pdf, mobi, fb2, cbz)
hasLocalCover
booleanWhether a cover extracted from the uploaded file is stored. Fetch it with getPersonalBookCover, which works under any supported authentication.
hiveId
stringLinked BookHive catalog entry ID
language
stringLanguage of the book
MIME type of the file
progress
refE-reader reading progress, when this book has been synced
shelfIds
arrayIDs of the personal shelves this book belongs to
File size in bytes
Title of the book
When the book record was last updated
#storageView
objectProperties
Total bytes this user is allowed to store
minimum: 0
Total bytes currently stored for this user
minimum: 0
#syncProgressView
objectProperties
device
stringName of the device that last reported progress
Reading progress as a fraction between 0 and 1
When progress was last synced
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
List the authenticated user's personal shelves with per-shelf book counts, plus library-wide totals and storage usage. This is the root call for a catalog client: it carries everything the OPDS root navigation feed renders, in one request. Unpaginated — `personal_shelf` is unique on (userDid, name) and these lists are small.
-
Get a single book from the authenticated user's personal library.
-
Download the raw ebook file for a book in the authenticated user's personal library. Responds with the stored bytes, a strong ETag equal to the content hash, and a `Content-Disposition: attachment` filename. Honours `If-None-Match` with a 304, so an e-reader syncing on a schedule does not re-download every book. The XRPC equivalent of GET /opds/books/{hash}/download/{name}.ext.
-
Cover image for a book in the authenticated user's personal library. Serves the cover extracted from the uploaded file when there is one; otherwise, if the book is linked to a BookHive catalog entry, responds 302 to the public image proxy for that entry. The XRPC equivalent of GET /opds/books/{hash}/cover.
-
Get books currently in a user's library.