Get Usenet List
GET {{api_base}}/{{api_version}}/api/usenet/mylist?bypass_cache=boolean&id=integer&offset=integer&limit=integer
Overview
Gets the user's usenet download list. This gives you the needed information to perform other usenet actions. Unlike Torrents, this information is updated on its own every 5 seconds for live usenet downloads.
Authorization
Requires an API key using the Authorization Bearer Header.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
bypass_cache | string | Allows you to bypass the cached data, and always get fresh information. Useful if constantly querying for fresh download stats. Otherwise, we request that you save our database a few calls. | |
id | string | Determines the usenet download requested, will return an object rather than list. Optional. | |
offset | string | Determines the offset of items to get from the database. Default is 0. Optional. | |
limit | string | Determines the number of items to recieve per request. Default is 1000. Optional. |
RESPONSES
status: OK
{"success":true,"error":null,"detail":"Usenet list retrieved successfully.","data":[{"id":0,"hash":"XXXXXXXXXXXXXXXXXXXXXXXXXX","created_at":"2023-12-22T22:12:34.78989+00:00","updated_at":"2023-12-22T16:12:41.552423+00:00","size":0,"active":true,"auth_id":"XXXXXXXXXXXXXXXXXXXXXXXXX","download_state":"downloading","progress":1,"download_speed":0,"upload_speed":0,"name":"UsenetName","eta":8640000,"server":0,"torrent_file":false,"expires_at":"2024-01-05T22:13:10.135864+00:00","download_present":true,"download_finished":true,"files":[{"id":0,"md5":"XXXXXXXXXXXXXXXXXXXXXXXXX","s3_path":"/hash/usenet_name/filename.ext","name":"UsenetFolder/UsenetName","size":0,"mimetype":"application/zip","short_name":"filename.ext"}],"inactive_check":0,"availability":0}]}