List book's positions

The Positions API is a proposed standard for OPDS 2 and Readium. It is used by the Epub Reader.

GET /api/v1/books/{bookId}/positions

List book's positions

cURL

curl --request GET \
  --url https://demo.komga.org/api/v1/books/{bookId}/positions \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "positions": [
    {
      "href": "<string>",
      "type": "<string>",
      "koboSpan": "<string>",
      "text": {
        "after": "<string>",
        "before": "<string>",
        "highlight": "<string>"
      },
      "title": "<string>"
    }
  ],
  "total": 123
}

Authorizations

basicAuthapiKey

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

bookId · string · required

Response

200

application/json

OK

positions · object[] · required

Show child attributes

total · integer<int32> · required