OPDS Catalog

3 endpoints.

Get the OPDS Catalog

GEThttp://localhost:3000/api/opds

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

200OPDS catalog XML

This response carries no example body.

ServerAPI token

categoryquery

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.

Get a specific archive through OPDS

GEThttp://localhost:3000/api/opds/{id}

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

200OPDS entry XML

This response carries no example body.

ServerAPI token

idpath

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.

OPDS-PSE

GEThttp://localhost:3000/api/opds/{id}/pse

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

Path parameters

idstringrequired

Query parameters

pageintegeroptional

Responses

200Image file for the requested page

This response carries no example body.

ServerAPI token

idpathpagequery

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.