Reader

Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.

get/api/Reader/bookmark-info

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/Reader/bookmark-info
  • Auth
    API key in header x-api-key

Query parameters

seriesIdinteger

Series Id for all bookmarks

includeDimensionsboolean

Include file dimensions (extra I/O). Defaults to true.

Response

OK

seriesNamestring nullable
seriesFormat0 | 1 | 2 | 3 | 4

Members:

  • 0 — Image
  • 1 — Archive
  • 2 — Unknown
  • 3 — EPUB (Epub)
  • 4 — PDF (Pdf)
seriesIdinteger
libraryIdinteger
libraryType0 | 1 | 2 | 3 | 4 | 5

Members:

  • 0 — Manga
  • 1 — Comic (Flexible) (Comic)
  • 2 — Book
  • 3 — Image
  • 4 — Light Novel (LightNovel)
  • 5 — Comic (ComicVine)
pagesinteger
doublePairsobject nullable

Changes

No recorded changes to this operation across all 136 revisions of this API.