diff --git a/Web-API-Documentation.md b/Web-API-Documentation.md index 72444fb..2c69264 100644 --- a/Web-API-Documentation.md +++ b/Web-API-Documentation.md @@ -1077,28 +1077,50 @@ HTTP Status Code | Scenario The response is a JSON array with the following fields -Property | Type | Description -------------------|---------|------------ -`hash` | string | Torrent hash -`name` | string | Torrent name -`size` | integer | Total size (bytes) of files selected for download -`progress` | float | Torrent progress (percentage/100) -`dlspeed` | integer | Torrent download speed (bytes/s) -`upspeed` | integer | Torrent upload speed (bytes/s) -`priority` | integer | Torrent priority. Returns -1 if queuing is disabled or torrent is in seed mode -`num_seeds` | integer | Number of seeds connected to -`num_complete` | integer | Number of seeds in the swarm -`num_leechs` | integer | Number of leechers connected to -`num_incomplete` | integer | Number of leechers in the swarm -`ratio` | float | Torrent share ratio. Max ratio value: 9999. -`eta` | integer | Torrent ETA (seconds) -`state` | string | Torrent state. See table here below for the possible values -`seq_dl` | bool | True if sequential download is enabled -`f_l_piece_prio` | bool | True if first last piece are prioritized -`category` | string | Category of the torrent -`tags` | string | Comma-concatenated tag list of the torrent -`super_seeding` | bool | True if super seeding is enabled -`force_start` | bool | True if force start is enabled for this torrent +Property | Type | Description +---------------------|---------|------------ +`added_on` | integer | Time (Unix Epoch) when the torrent was added to the client +`amount_left` | integer | Amount of data left to download (bytes) +`auto_tmm` | bool | Whether this torrent is managed by Automatic Torrent Management +`category` | string | Category of the torrent +`completed` | integer | Amount of transfer data completed (bytes) +`completion_on` | integer | Time (Unix Epoch) when the torrent completed +`dl_limit` | integer | Torrent download speed limit (bytes/s). `-1` if ulimited. +`dlspeed` | integer | Torrent download speed (bytes/s) +`downloaded` | integer | Amount of data downloaded +`downloaded_session` | integer | Amount of data downloaded this session +`eta` | integer | Torrent ETA (seconds) +`f_l_piece_prio` | bool | True if first last piece are prioritized +`force_start` | bool | True if force start is enabled for this torrent +`hash` | string | Torrent hash +`last_activity` | integer | Last time (Unix Epoch) when a chunk was downloaded/uploaded +`magnet_uri` | string | Magnet URI corresponding to this torrent +`max_ratio` | float | Maximum share ratio until torrent is stopped from seeding/uploading +`max_seeding_time` | integer | Maximum seeding time (seconds) until torrent is stopped from seeding +`name` | string | Torrent name +`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`: