Difference between revisions of "OPDS"
Jump to navigation
Jump to search
(Listed all search query parameters) |
|||
| Line 4: | Line 4: | ||
== End points == | == End points == | ||
* | * https://library.kiwix.org/catalog/searchdescription.xml which proposes an overall OPDS description in XML format | ||
* https://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). | ||
** <code>tag=wikipedia</code> to filter | ** <code>tag=wikipedia</code> to list only entries with all of the specified tags. | ||
** <code>notag=</code>_videos:yes to filter out entries with any of the specified tags. | |||
** <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>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. | ||
Revision as of 11:01, 3 March 2021
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
- https://library.kiwix.org/catalog/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 list only entries with all of the specified tags.notag=_videos:yes to filter out entries with any of the specified tags.name=wikipedia_ny_allto list only entries with the specified name (exact match).maxsize=1234567890to filter out entries larger than the specified size.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