Difference between revisions of "OPDS"
Jump to navigation
Jump to search
(Updated params to OPDS search endpoint) |
(http -> https) |
||
| Line 3: | Line 3: | ||
== 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/searchdescription.xml] which proposes an overall OPDS description in XML format | ||
* | * 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 9: | ||
** <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. | ||
* | * https://library.kiwix.org/catalog/root.xml which proposed the index of all the books | ||
== See also == | == See also == | ||
Revision as of 10:59, 15 January 2020
Kiwix-serve provides an OPDS feed which allow to search through available content. A live instance can be see at https://library.kiwix.org/.
End points
- https://library.kiwix.org/searchdescription.xml which proposes an overall OPDS description in XML format
- https://library.kiwix.org/catalog/search which accepts a few GET parameter:
q=<PATTERN>which proposes a keyword based search in the catalogue (on title and description).lang=frawhich proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata).tag=wikipediato filter on tags (multiple values as intersection).count=2to limit the number of results.start=1to indicate an offset in search results.
- https://library.kiwix.org/catalog/root.xml which proposed the index of all the books