Difference between revisions of "OPDS"

From Kiwix
Jump to navigation Jump to search
(→‎End points: Documented support for multiple languages; improved formatting)
(→‎End points: Added /catalog/v2/entry)
Line 27: Line 27:


* https://library.kiwix.org/catalog/v2/languages provides access to entries grouped by language
* https://library.kiwix.org/catalog/v2/languages provides access to entries grouped by language
* [https://library.kiwix.org/catalog/v2/entry/ENTRY_ID https://library.kiwix.org/catalog/v2/entry/''<ENTRY_ID>''] provides access to full entry info (useful in combination with <code>/catalog/v2/partial_entries</code>)


=== Legacy endpoint ===
=== Legacy endpoint ===

Revision as of 09:13, 2 November 2022

Kiwix-serve provides an OPDS feed. This API allows to retrieve the library metadata, but not the content themselves.

A live instance can be see at https://library.kiwix.org/.

End points

/catalog/v2

  • https://library.kiwix.org/catalog/v2/entries provides access to full entries. It accepts the following GET parameters:
    • q=<PATTERN> which proposes a keyword based search in the catalogue (on title and description).
    • lang=fra defines a language filter. Use an ISO639-3 language value (like in ZIM metadata). Multiple languages can be specified as a comma separated list (e.g. lang=fra,deu)
    • tag=wikipedia;_videos:no to list only entries with all of the specified tags.
    • notag=ted;_videos:yes to filter out (exclude) entries with any of the specified tags.
    • category=phet to list all entries with specified category.
    • name=wikipedia_ny_all to list only entries with the specified name (exact match).
    • maxsize=1234567890 to filter out entries larger than the specified size.
    • count=2 to limit the number of results.
    • start=1 to indicate an offset in search results.

Legacy endpoint

See also

Retrieved from "https://wiki.kiwix.org/w/index.php?title=OPDS&oldid=37697"