Difference between revisions of "OPDS"

From Kiwix
Jump to navigation Jump to search
(→‎End points: Added /catalog/v2/entry)
(Put a pointer to the online documentation)
 
Line 1: Line 1:
[[Kiwix-serve]] provides an [https://en.wikipedia.org/wiki/Open_Publication_Distribution_System OPDS] feed. This API allows to retrieve the library metadata, but not the content themselves.
[[Kiwix-serve]] provides an [https://en.wikipedia.org/wiki/Open_Publication_Distribution_System OPDS] feed. This API allows to retrieve the library metadata, but not the content themselves.
A [https://kiwix-tools.readthedocs.io/en/latest/ full documentation of the OPDS API and other API offered by kiwix-serve is available online].


A live instance can be see at https://library.kiwix.org/.
A live instance can be see at https://library.kiwix.org/.
== End points ==
=== /catalog/v2 ===
* https://library.kiwix.org/catalog/v2/root.xml lists all other <code>/catalog/v2</code> endpoints.
* https://library.kiwix.org/catalog/v2/searchdescription.xml describes the <code>/catalog/v2/entries</code> endpoint.
* https://library.kiwix.org/catalog/v2/entries provides access to full entries. It accepts the following GET parameters:
** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue (on title and description).
** <code>lang=fra</code> 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. <code>lang=fra,deu</code>)
** <code>tag=wikipedia;_videos:no</code> to list only entries with all of the specified tags.
** <code>notag=ted;_videos:yes</code> to filter out (exclude) entries with any of the specified tags.
** <code>category=phet</code> to list all entries with specified category.
** <code>name=wikipedia_ny_all</code> to list only entries with the specified name (exact match).
** <code>maxsize=1234567890</code> to filter out entries larger than the specified size.
** <code>count=2</code> to limit the number of results.
** <code>start=1</code> to indicate an offset in search results.
* https://library.kiwix.org/catalog/v2/partial_entries provides access to partial entries. It accepts the same GET parameters as its full entry counterpart.
* https://library.kiwix.org/catalog/v2/categories provides access to entries grouped by category
* 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 ===

Latest revision as of 13:03, 19 February 2023

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

A full documentation of the OPDS API and other API offered by kiwix-serve is available online.

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

Legacy endpoint

See also

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