Difference between revisions of "OPDS"
Jump to navigation
Jump to search
(added category tag info for /catalog/search endpoint) |
(→End points: Documented /catalog/v2 endpoints) |
||
| Line 4: | Line 4: | ||
== End points == | == End points == | ||
* https://library.kiwix.org/catalog/searchdescription.xml | |||
* https://library.kiwix.org/catalog/ | === /catalog/v2 === | ||
* https://library.kiwix.org/catalog/v2/root.xml lists all other /catalog/v2 endpoints. | |||
* https://library.kiwix.org/catalog/v2/searchdescription.xml describes the /catalog/v2/entries 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>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 15: | Line 21: | ||
** <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 | |||
* 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 | |||
=== Legacy endpoint === | |||
* https://library.kiwix.org/catalog/root.xml lists all books. | |||
* https://library.kiwix.org/catalog/searchdescription.xml describes the /catalog/search endpoint. | |||
* https://library.kiwix.org/catalog/search allows to filter books. It accepts the same GET parameters as /catalog/v2/entries (see above). | |||
== See also == | == See also == | ||
Revision as of 18:22, 31 October 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/root.xml lists all other /catalog/v2 endpoints.
- https://library.kiwix.org/catalog/v2/searchdescription.xml describes the /catalog/v2/entries endpoint.
- 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=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.category=phetto list all entries with specified category.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/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
Legacy endpoint
- https://library.kiwix.org/catalog/root.xml lists all books.
- https://library.kiwix.org/catalog/searchdescription.xml describes the /catalog/search endpoint.
- https://library.kiwix.org/catalog/search allows to filter books. It accepts the same GET parameters as /catalog/v2/entries (see above).