OPDS Catalog

Endpoints related to OPDS catalog generation and serving.

Get the OPDS Catalog

get

Get the Archive Index as an OPDS 1.2 Catalog with PSE 1.1 compatibility.

Query parameters
categorystringOptional

Category ID. If passed, the OPDS catalog will be filtered to only show archives from this category.

Responses
200

OPDS catalog XML

application/xml
Responsestring
get
/opds
200

OPDS catalog XML

Get a specific archive through OPDS

get

Returns a specific OPDS item as XML. This will show only one <entry> for the given ID in the result, instead of all the archives.

Path parameters
idstringRequired
Responses
200

OPDS entry XML

application/xml
Responsestring
get
/opds/{id}
200

OPDS entry XML

OPDS-PSE

get

Returns a specific image page for OPDS-PSE as XML.

Path parameters
idstringRequired
Query parameters
pageintegerOptional
Responses
200

Image file for the requested page

application/octet-stream
Responsestring Β· binary
get
/opds/{id}/pse
200

Image file for the requested page

Last updated