Skip to content

Book Reader API

Introduction

This API is intended to be used to retrieve Books directly from your end user app.

If you are looking for the API to create, update and delete bitmark JSON, please refer to our Publisher API.

This API uses lightweight and heavyweight objects. Heavyweight objects containing the content itself. Lightweight objects just reference to the content.

Because Books can get quite heavy (up to several MB), you should only request the portion you need, like the book info, table of content (toc) or a certain chapter or bit. However, the full book might be downloaded for offline reading.

Info, TOC and Chapters

You can request a full bitmark JSON Book or a part of it (chapter, sub-chapter, ...).

/books/3/info

/books/3/toc
/books/3/glossary
/books/3/index
/books/3/media-index


/books/3/chapters/3
/books/3/chapters/3/2/1
/books/3/chapters?id=...
/books/3/chapters?anchor=...

Note

@sese: Book Reader API filters out all internal bitmark comments!

Resources

You can get a list of all resources (images, audio files, video, ...) of a book or a chapter. Use this for offline reading or caching.

/books/3/resources
/books/3/chapters/4/2/resources

Full Text Search and Filter

Full text search and filters work for Books and Bits.

Request

GET /books?q=Dolphins
GET /bits?q=Dolphins&type=cloze
GET /books/3/bits?q=Elephants
GET /bits?q=Dolphins&l=en&t=cloze&r=video&f=bitmark--