Updated API (markdown)

d47081 2023-11-05 00:44:19 +02:00
parent 27935651e6
commit f0af538a41

18
API.md

@ -1,9 +1,13 @@
Get / find recent torrents
Recent torrents
`/api/torrents?search=value&sensitive=0&locales=en|uk&yggdrasil=1&page=1`
GET `/api/torrents?search=value&sensitive=false&locales=en|uk&yggdrasil=1&page=1`
* `search` - optional, filter results by keyword, recent uploads if not provided
* `sensitive` - optional, 1 or 0, all results if not provided
* `locales` - optional, filter results by locales, all locales if not provided
* `yggdrasil` - optional, filter non-yggdrasil resources from response, all resources by default
* `page` - optional, 1 by default
* `search` - `string` - optional, filter results by keyword, recent uploads if not provided
* `filter` - `bool` - optional, enable special rules to ignore user session
* `sensitive` - `bool` - optional, 1 or 0, all results if not provided
* `yggdrasil` - `bool` - optional, filter non-yggdrasil resources from downloads, all resources by default
* `locales` - `string` (loc1|loc2|.._) - optional, filter results by locales, all if not provided
* `categories` - `string` (cat1|cat2|..) - optional, filter results by categories, all if not provided
* `page` - int - optional, 1 by default
_* Method follows user settings by IP session or ignore if the `filter` option provided_