Qodex.ai

Get Torrent List

GET {{api_base}}/{{api_version}}/api/torrents/mylist?bypass_cache=boolean&id=integer&offset=integer&limit=integer

Overview

Gets the user's torrent list. This gives you the needed information to perform other torrent actions. This information only gets updated every 600 seconds, or when the Request Update On Torrent request is sent to the relay API .

Download States:

  • downloading -> The torrent is currently downloading.

  • uploading -> The torrent is currently seeding.

  • stalled (no seeds) -> The torrent is trying to download, but there are no seeds connected to download from.

  • paused -> The torrent is paused.

  • completed -> The torrent is completely downloaded. Do not use this for download completion status.

  • cached -> The torrent is cached from the server.

  • metaDL -> The torrent is downloading metadata from the hoard.

  • checkingResumeData -> The torrent is checking resumable data.

All other statuses are basic qBittorrent states. Check out here for the full list .

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 torrent 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. |

HEADERS

| Key | Datatype | Required | Description |

RESPONSES

status: OK

{"success":true,"error":null,"detail":"Torrent 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","magnet":"XXXXXXXXXXXXXXXXXXXXXXXXXXXX","size":0,"active":true,"auth_id":"XXXXXXXXXXXXXXXXXXXXXXXXX","download_state":"downloading","seeds":0,"peers":0,"ratio":0,"progress":1,"download_speed":0,"upload_speed":0,"name":"TorrentName","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/torrent_name/filename.ext","name":"TorrentFolder/TorrentName","size":0,"mimetype":"application/zip","short_name":"filename.ext"}],"inactive_check":0,"availability":0}]}