Tell us your story
Tell us your story
How has offline Wikipedia affected you? The Wikimedia Foundation (the non-profit that supports Wikipedia) is looking for personal, diverse and inspiring stories about how offline Wikipedia affects the world. If you have a personal story that you would like to share, please contact: stories@kiwix.org. Thank you!

Difference between revisions of "OPDS"

From Kiwix
Jump to: navigation, search
(Updated params to OPDS search endpoint)
(End points)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Kiwix-serve]] provides an '''[https://en.wikipedia.org/wiki/OPDS OPDS]''' feed which allow to search through available content. A live instance can be see at https://library.kiwix.org/.
+
[[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 live instance can be see at https://library.kiwix.org/.
  
 
== End points ==
 
== End points ==
* [https://library.kiwix.org/catalog/searchdescription.xml https://library.kiwix.org/searchdescription.xml] which proposes an overall OPDS description in XML format
+
* [https://library.kiwix.org/catalog/searchdescription.xml https://library.kiwix.org/catalog/searchdescription.xml] which proposes an overall OPDS description in XML format
* http://library.kiwix.org/catalog/search which accepts a few GET parameter:
+
* https://library.kiwix.org/catalog/search which accepts a few GET parameter:
 
** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue (on title and description).
 
** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue (on title and description).
 
** <code>lang=fra</code> which proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata).
 
** <code>lang=fra</code> which proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata).
Line 9: Line 11:
 
** <code>count=2</code> to limit the number of results.
 
** <code>count=2</code> to limit the number of results.
 
** <code>start=1</code> to indicate an offset in search results.
 
** <code>start=1</code> to indicate an offset in search results.
* http://library.kiwix.org/catalog/root.xml which proposed the index of all the books
+
* https://library.kiwix.org/catalog/root.xml which proposed the index of all the books
  
 
== See also ==
 
== See also ==

Latest revision as of 19:49, 17 May 2020

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

See also