mirrors/qBittorrent
1
0
Fork 0
mirror of https://github.com/qbittorrent/qBittorrent.git synced 2024-10-22 10:46:04 +03:00
Code Issues Projects Releases Packages Wiki Activity

Update docs for fields of JSON response of /api/v2/torrents/info. See TODOs for incomplete descriptions

Francisco Pombal 2019-12-06 00:30:11 +00:00
parent 2da85ea805
commit c5633f1988
1 changed files with 44 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
Web-API-Documentation.md

@ -1077,28 +1077,50 @@ HTTP Status Code | Scenario
The response is a JSON array with the following fields The response is a JSON array with the following fields
Property | Type | Description Property | Type | Description
------------------|---------|------------ ---------------------|---------|------------
`hash` | string | Torrent hash `added_on` | integer | Time (Unix Epoch) when the torrent was added to the client
`name` | string | Torrent name `amount_left` | integer | Amount of data left to download (bytes)
`size` | integer | Total size (bytes) of files selected for download `auto_tmm` | bool | Whether this torrent is managed by Automatic Torrent Management
`progress` | float | Torrent progress (percentage/100) `category` | string | Category of the torrent
`dlspeed` | integer | Torrent download speed (bytes/s) `completed` | integer | Amount of transfer data completed (bytes)
`upspeed` | integer | Torrent upload speed (bytes/s) `completion_on` | integer | Time (Unix Epoch) when the torrent completed
`priority` | integer | Torrent priority. Returns -1 if queuing is disabled or torrent is in seed mode `dl_limit` | integer | Torrent download speed limit (bytes/s). `-1` if ulimited.
`num_seeds` | integer | Number of seeds connected to `dlspeed` | integer | Torrent download speed (bytes/s)
`num_complete` | integer | Number of seeds in the swarm `downloaded` | integer | Amount of data downloaded
`num_leechs` | integer | Number of leechers connected to `downloaded_session` | integer | Amount of data downloaded this session
`num_incomplete` | integer | Number of leechers in the swarm `eta` | integer | Torrent ETA (seconds)
`ratio` | float | Torrent share ratio. Max ratio value: 9999. `f_l_piece_prio` | bool | True if first last piece are prioritized
`eta` | integer | Torrent ETA (seconds) `force_start` | bool | True if force start is enabled for this torrent
`state` | string | Torrent state. See table here below for the possible values `hash` | string | Torrent hash
`seq_dl` | bool | True if sequential download is enabled `last_activity` | integer | Last time (Unix Epoch) when a chunk was downloaded/uploaded
`f_l_piece_prio` | bool | True if first last piece are prioritized `magnet_uri` | string | Magnet URI corresponding to this torrent
`category` | string | Category of the torrent `max_ratio` | float | Maximum share ratio until torrent is stopped from seeding/uploading
`tags` | string | Comma-concatenated tag list of the torrent `max_seeding_time` | integer | Maximum seeding time (seconds) until torrent is stopped from seeding
`super_seeding` | bool | True if super seeding is enabled `name` | string | Torrent name
`force_start` | bool | True if force start is enabled for this torrent `num_complete` | integer | Number of seeds in the swarm
`num_incomplete` | integer | Number of leechers in the swarm
`num_leechs` | integer | Number of leechers connected to
`num_seeds` | integer | Number of seeds connected to
`priority` | integer | Torrent priority. Returns -1 if queuing is disabled or torrent is in seed mode
`progress` | float | Torrent progress (percentage/100)
`ratio` | float | Torrent share ratio. Max ratio value: 9999.
`ratio_limit` | float | TODO (what is different from `max_ratio`?)
`save_path` | string | Path where this torrent's data is stored
`seeding_time_limit` | integer | TODO (what is different from `max_seeding_time`?)
`seen_complete` | integer | Time (Unix Epoch) when this torrent was last seen complete
`seq_dl` | bool | True if sequential download is enabled
`size` | integer | Total size (bytes) of files selected for download
`state` | string | Torrent state. See table here below for the possible values
`super_seeding` | bool | True if super seeding is enabled
`tags` | string | Comma-concatenated tag list of the torrent
`time_active` | integer | Total active time (seconds)
`total_size` | integer | Total size (bytes) of all file in this torrent (including unselected ones)
`tracker` | string | The first tracker with working status. (TODO: what is returned if no tracker is working?)
`up_limit` | integer | Torrent upload speed limit (bytes/s). `-1` if ulimited.
`uploaded` | integer | Amount of data uploaded
`uploaded_session` | integer | Amount of data uploaded this session
`upspeed` | integer | Torrent upload speed (bytes/s)
Possible values of `state`: Possible values of `state`: