source: trunk/doc/rpc-spec.txt @ 8130

Last change on this file since 8130 was 8130, checked in by livings124, 13 years ago

libT support for #1679 Schedule Speed Limit mode based on days, not just time

File size: 26.1 KB
Line 
11.  Introduction
2
3   This document describes a protocol for interacting with Transmission
4   sessions remotely.
5
61.1  Terminology
7
8   The JSON terminology in RFC 4627 is used.
9
10   In benc terms, a JSON "array" is equivalent to a benc list,
11   a JSON "object" is equivalent to a benc dictionary,
12   and a JSON object's "keys" are the dictionary's string keys.
13
142.  Message Format
15
16   Messages are formatted in a subset of JSON easily represented
17   as bencoded data.  Arrays, objects, strings, and whole numbers
18   all have one-to-one mappings between JSON and benc.
19
20   Booleans and floating-point numbers are also used in the JSON messages.
21   Those two types aren't native to benc, so they're encoded this way:
22   Booleans are encoded as numbers where 0 is false and 1 is true.
23   Floating-point numbers are represented as strings.
24
25   Messages are formatted as objects.  There are two types:
26   requests (described in 2.1) and responses (described in 2.2).
27
28   All text MUST be UTF-8 encoded.
29
302.1.  Requests
31
32   Requests support three keys:
33
34   (1) A required "method" string telling the name of the method to invoke
35   (2) An optional "arguments" object of key/value pairs
36   (3) An optional "tag" number used by clients to track responses.
37       If provided by a request, the response MUST include the same tag.
38
392.2.  Responses
40
41   Reponses support three keys:
42
43   (1) A required "result" string whose value MUST be "success" on success,
44       or an error string on failure.
45   (2) An optional "arguments" object of key/value pairs
46   (3) An optional "tag" number as described in 2.1.
47
482.3.  Transport Mechanism
49
50   HTTP POSTing a JSON-encoded request is the preferred way of communicating
51   with a Transmission RPC server.  The current Transmission implementation
52   has the default URL as http://host:9091/transmission/rpc.  Clients
53   may use this as a default, but should allow the URL to be reconfigured,
54   since the port and path may be changed to allow mapping and/or multiple
55   daemons to run on a single server.
56
57   In addition to POSTing, there's also a simple notation for sending
58   requests in the query portion of a URL.  This is not as robust, but can
59   be useful for debugging and simple tasks.  The notation works as follows:
60
61   (1) Any key not "tag" or "method" is treated as an argument.
62   (2) The "arguments" key isn't needed, since data isn't nested.
63   (3) If the value in a key/value pair can be parsed as a number, then it is.
64       Otherwise if it can be parsed as an array of numbers, then it is.
65       Otherwise, it's parsed as a string.
66
67   Examples:
68   ?method=torrent-start&ids=1,2
69   ?method=session-set&speed-limit-down=50&speed-limit-down-enabled=1
70   
71
723.  Torrent Requests
73
743.1.  Torrent Action Requests
75
76   Method name          | libtransmission function
77   ---------------------+-------------------------------------------------
78   "torrent-start"      | tr_torrentStart
79   "torrent-stop"       | tr_torrentStop
80   "torrent-verify"     | tr_torrentVerify
81   "torrent-reannounce" | tr_torrentManualUpdate ("ask tracker for more peers")
82
83   Request arguments: "ids", which specifies which torrents to use.
84                      All torrents are used if the "ids" argument is omitted.
85                      "ids" should be one of the following:
86                      (1) an integer referring to a torrent id
87                      (2) a list of torrent id numbers, sha1 hash strings, or both
88                      (3) a string, "recently-active", for recently-active torrents
89
90   Response arguments: none
91
923.2.  Torrent Mutators
93
94   Method name: "torrent-set"
95
96   Request arguments:
97
98   string                            | value type & description
99   ----------------------------------+-------------------------------------------------
100   "downloadLimit"                   | number     maximum download speed (in K/s)
101   "downloadLimited"                 | 'boolean'  true if "downloadLimit" is honored
102   "files-wanted"                    | array      indices of file(s) to download
103   "files-unwanted"                  | array      indices of file(s) to not download
104   "honorsSessionLimits"             | 'boolean'  true if session upload limits are honored
105   "ids"                             | array      torrent list, as described in 3.1
106   "peer-limit"                      | number     maximum number of peers
107   "priority-high"                   | array      indices of high-priority file(s)
108   "priority-low"                    | array      indices of low-priority file(s)
109   "priority-normal"                 | array      indices of normal-priority file(s)
110   "seedRatioLimit"                  | 'double'   session seeding ratio
111   "seedRatioLimited"                | 'boolean'  true if "seedRatioLimit" is honored
112   "uploadLimit"                     | number     maximum upload speed (in K/s)
113   "uploadLimited"                   | 'boolean'  true if "uploadLimit" is honored
114
115   Just as an empty "ids" value is shorthand for "all ids", using an empty array
116   for "files-wanted", "files-unwanted", "priority-high", "priority-low", or
117   "priority-normal" is shorthand for saying "all files".
118
119   Response arguments: none
120
1213.3.  Torrent Accessors
122
123   Method name: "torrent-get".
124
125   Request arguments:
126
127   (1) An opional "ids" array as described in 3.1.
128   (2) A required "fields" array of keys. (see list below)
129
130   Response arguments:
131
132   (1) A "torrents" array of objects, each of which contains
133       the key/value pairs matching the request's "fields" argument.
134
135   key                             | type                        | source
136   --------------------------------+-----------------------------+---------
137   activityDate                    | number                      | tr_stat
138   addedDate                       | number                      | tr_stat
139   announceResponse                | string                      | tr_stat
140   announceURL                     | string                      | tr_stat
141   comment                         | string                      | tr_info
142   corruptEver                     | number                      | tr_stat
143   creator                         | string                      | tr_info
144   dateCreated                     | number                      | tr_info
145   desiredAvailable                | number                      | tr_stat
146   doneDate                        | number                      | tr_stat
147   downloadDir                     | string                      | tr_torrent
148   downloadedEver                  | number                      | tr_stat
149   downloaders                     | number                      | tr_stat
150   downloadLimit                   | number                      | tr_torrent
151   downloadLimited                 | 'boolean'                   | tr_torrent
152   error                           | number                      | tr_stat
153   errorString                     | number                      | tr_stat
154   eta                             | number                      | tr_stat
155   files                           | array (see below)           | n/a
156   fileStats                       | array (see below)           | n/a
157   hashString                      | string                      | tr_info
158   haveUnchecked                   | number                      | tr_stat
159   haveValid                       | number                      | tr_stat
160   honorsSessionLimits             | 'boolean'                   | tr_torrent
161   id                              | number                      | tr_torrent
162   isPrivate                       | 'boolean'                   | tr_torrent
163   lastAnnounceTime                | number                      | tr_stat
164   lastScrapeTime                  | number                      | tr_stat
165   leechers                        | number                      | tr_stat
166   leftUntilDone                   | number                      | tr_stat
167   manualAnnounceTime              | number                      | tr_stat
168   maxConnectedPeers               | number                      | tr_torrent
169   name                            | string                      | tr_info
170   nextAnnounceTime                | number                      | tr_stat
171   nextScrapeTime                  | number                      | tr_stat
172   peer-limit                      | number                      | tr_torrent
173   peers                           | array (see below)           | n/a
174   peersConnected                  | number                      | tr_stat
175   peersFrom                       | object (see below)          | n/a
176   peersGettingFromUs              | number                      | tr_stat
177   peersKnown                      | number                      | tr_stat
178   peersSendingToUs                | number                      | tr_stat
179   percentDone                     | 'double'                    | tr_stat
180   pieces                          | string (see below)          | tr_torrent
181   pieceCount                      | tnumber                     | tr_info
182   pieceSize                       | tnumber                     | tr_info
183   priorities                      | array (see below)           | n/a
184   ratio                           | 'double'                    | tr_stat
185   rateDownload (B/s)              | number                      | tr_stat
186   rateUpload (B/s)                | number                      | tr_stat
187   recheckProgress                 | 'double'                    | tr_stat
188   scrapeResponse                  | string                      | tr_stat
189   scrapeURL                       | string                      | tr_stat
190   seeders                         | number                      | tr_stat
191   seedRatioLimit                  | 'double'                    | tr_torrent
192   seedRatioMode                   | number                      | tr_ratiolimit
193   sizeWhenDone                    | number                      | tr_stat
194   startDate                       | number                      | tr_stat
195   status                          | number                      | tr_stat
196   swarmSpeed (K/s)                | number                      | tr_stat
197   timesCompleted                  | number                      | tr_stat
198   trackers                        | array (see below)           | n/a
199   totalSize                       | number                      | tr_info
200   torrentFile                     | string                      | tr_info
201   uploadedEver                    | number                      | tr_stat
202   uploadLimit                     | number                      | tr_torrent
203   uploadLimited                   | 'boolean'                   | tr_torrent
204   uploadRatio                     | 'double'                    | tr_stat
205   wanted                          | array (see below)           | n/a
206   webseeds                        | array (see below)           | n/a
207   webseedsSendingToUs             | number                      | tr_stat
208                                   |                             |
209                                   |                             |
210   -----------------------+--------+-----------------------------+
211   files                  | array of objects, each containing:   |
212                          +-------------------------+------------+
213                          | key                     | type       |
214                          | bytesCompleted          | number     | tr_torrent
215                          | length                  | number     | tr_info
216                          | name                    | string     | tr_info
217   -----------------------+--------------------------------------+
218   fileStats              | a file's non-constant properties.    |
219                          | array of tr_info.filecount objects,  |
220                          | each containing:                     |
221                          +-------------------------+------------+
222                          | bytesCompleted          | number     | tr_torrent
223                          | wanted                  | 'boolean'  | tr_info
224                          | priority                | number     | tr_info
225   -----------------------+--------------------------------------+
226   peers                  | array of objects, each containing:   |
227                          +-------------------------+------------+
228                          | address                 | string     | tr_peer_stat
229                          | clientName              | string     | tr_peer_stat
230                          | clientIsChoked          | 'boolean'  | tr_peer_stat
231                          | clientIsInterested      | 'boolean'  | tr_peer_stat
232                          | isDownloadingFrom       | 'boolean'  | tr_peer_stat
233                          | isEncrypted             | 'boolean'  | tr_peer_stat
234                          | isIncoming              | 'boolean'  | tr_peer_stat
235                          | isUploadingTo           | 'boolean'  | tr_peer_stat
236                          | peerIsChoked            | 'boolean'  | tr_peer_stat
237                          | peerIsInterested        | 'boolean'  | tr_peer_stat
238                          | port                    | number     | tr_peer_stat
239                          | progress                | 'double'   | tr_peer_stat
240                          | rateToClient (B/s)      | number     | tr_peer_stat
241                          | rateToPeer (B/s)        | number     | tr_peer_stat
242   -----------------------+--------------------------------------+
243   peersFrom              | an object containing:                |
244                          +-------------------------+------------+
245                          | fromCache               | number     | tr_stat
246                          | fromIncoming            | number     | tr_stat
247                          | fromPex                 | number     | tr_stat
248                          | fromTracker             | number     | tr_stat
249   -----------------------+--------------------------------------+
250   pieces                 | A bitfield holding pieceCount flags  | tr_torrent
251                          | which are set to 'true' if we have   |
252                          | the piece matching that position.    |
253                          | JSON doesn't allow raw binary data,  |
254                          | so this is a base64-encoded string.  |
255   -----------------------+--------------------------------------+
256   priorities             | an array of tr_info.filecount        | tr_info
257                          | numbers. each is the tr_priority_t   |
258                          | mode for the corresponding file.     |
259   -----------------------+--------------------------------------+
260   trackers               | array of objects, each containing:   |
261                          +-------------------------+------------+
262                          | announce                | string     | tr_info
263                          | scrape                  | string     | tr_info
264                          | tier                    | number     | tr_info
265   -----------------------+--------------------------------------+
266   wanted                 | an array of tr_info.fileCount        | tr_info
267                          | 'booleans' true if the corresponding |
268                          | file is to be downloaded.            |
269   -----------------------+--------------------------------------+
270   webseeds               | an array of strings:                 |
271                          +-------------------------+------------+
272                          | webseed                 | string     | tr_info
273                          +-------------------------+------------+
274
275   Example:
276
277   Say we want to get the name and total size of torrents #7 and #10.
278
279   Request:
280
281      {
282         "arguments": {
283             "fields": [ "id", "name", "totalSize" ],
284             "ids": [ 7, 10 ]
285         },
286         "method": "torrent-get",
287         "tag": 39693
288      }
289
290
291   Response:
292
293      {
294         "arguments": {
295            "torrents": [
296               {
297                   "id": 10,
298                   "name": "Fedora x86_64 DVD",
299                   "totalSize", 34983493932,
300               },
301               {
302                   "id": 7,
303                   "name": "Ubuntu x86_64 DVD",
304                   "totalSize", 9923890123,
305               }
306            ]
307         },
308         "result": "success",
309         "tag": 39693
310      }
311
3123.4.  Adding a Torrent
313
314   Method name: "torrent-add"
315
316   Request arguments:
317
318   key                | value type & description
319   -------------------+-------------------------------------------------
320   "download-dir"     | string      path to download the torrent to
321   "filename"         | string      filename or URL of the .torrent file
322   "metainfo"         | string      base64-encoded .torrent content
323   "paused"           | 'boolean'   if true, don't start the torrent
324   "peer-limit"       | number      maximum number of peers
325   "files-wanted"     | array       indices of file(s) to download
326   "files-unwanted"   | array       indices of file(s) to not download
327   "priority-high"    | array       indices of high-priority file(s)
328   "priority-low"     | array       indices of low-priority file(s)
329   "priority-normal"  | array       indices of normal-priority file(s)
330
331   Either "filename" OR "metainfo" MUST be included.
332   All other arguments are optional.
333
334   Response arguments: on success, a "torrent-added" object in the
335                       form of one of 3.3's tr_info objects with the
336                       fields for id, name, and hashString.
337
3383.5.  Removing a Torrent
339
340   Method name: "torrent-remove"
341
342   Request arguments:
343
344   string                     | value type & description
345   ---------------------------+-------------------------------------------------
346   "ids"                      | array      torrent list, as described in 3.1
347   "delete-local-data"        | 'boolean'  delete local data. (default: false)
348
349   Response arguments: none
350
351
3524.   Session Requests
353
3544.1.  Session Arguments
355
356   string                     | value type & description
357   ---------------------------+-------------------------------------------------
358   "alt-speed-down"           | number     max global download speed (in K/s)
359   "alt-speed-enabled"        | 'boolean'  true means use the alt speeds
360   "alt-speed-time-begin"     | number     when to turn on alt speeds (units: minutes after midnight)
361   "alt-speed-time-enabled"   | 'boolean'  true means the scheduled on/off times are used
362   "alt-speed-time-end"       | number     when to turn off alt speeds (units: same)
363   "alt-speed-time-day"       | number     what day(s) to turn on alt speeds (look at tr_sched_day)
364   "alt-speed-up"             | number     max global upload speed (in K/s)
365   "blocklist-enabled"        | 'boolean'  true means enabled
366   "blocklist-size"           | number     number of rules in the blocklist
367   "encryption"               | string     "required", "preferred", "tolerated"
368   "download-dir"             | string     default path to download torrents
369   "peer-limit-global"        | number     maximum global number of peers
370   "peer-limit-per-torrent"   | number     maximum global number of peers
371   "pex-enabled"              | 'boolean'  true means allow pex in public torrents
372   "peer-port"                | number     port number
373   "peer-port-random-on-start"| 'boolean'  true means pick a random peer port on launch
374   "port-forwarding-enabled"  | 'boolean'  true means enabled
375   "rpc-version"              | number     the current RPC API version
376   "rpc-version-minimum"      | number     the minimum RPC API version supported
377   "speed-limit-down"         | number     max global download speed (in K/s)
378   "speed-limit-down-enabled" | 'boolean'  true means enabled
379   "speed-limit-up"           | number     max global upload speed (in K/s)
380   "speed-limit-up-enabled"   | 'boolean'  true means enabled
381   "version"                  | string     long version string "$version ($revision)"
382
383   "rpc-version" indicates the RPC interface version supported by the RPC server.
384   It is incremented when a new version of Transmission changes the RPC interface.
385
386   "rpc-version-minimum" indicates the oldest API supported by the RPC server.
387   It is changes when a new version of Transmission changes the RPC interface
388   in a way that is not backwards compatible.  There are no plans for this
389   to be common behavior.
390
3914.1.1.  Mutators
392
393   Method name: "session-set"
394   Request arguments: one or more of 4.1's arguments, except: "blocklist-size",
395                      "rpc-version", "rpc-version-minimum", and "version"
396   Response arguments: none
397
3984.1.2.  Accessors
399
400   Method name: "session-get"
401   Request arguments: none
402   Response arguments: all of 4.1's arguments
403
4044.2.  Session Statistics
405
406   Method name: "session-stats"
407
408   Request arguments: none
409
410   Response arguments:
411
412   string                     | value type
413   ---------------------------+-------------------------------------------------
414   "activeTorrentCount"       | number
415   "downloadSpeed"            | number
416   "pausedTorrentCount"       | number
417   "torrentCount"             | number
418   "uploadSpeed"              | number
419   ---------------------------+-------------------------------+
420   "cumulative-stats"         | object, containing:           |
421                              +------------------+------------+
422                              | uploadedBytes    | number     | tr_session_stats
423                              | downloadedBytes  | number     | tr_session_stats
424                              | filesAdded       | number     | tr_session_stats
425                              | sessionCount     | number     | tr_session_stats
426                              | secondsActive    | number     | tr_session_stats
427   ---------------------------+-------------------------------+
428   "current-stats"            | object, containing:           |
429                              +------------------+------------+
430                              | uploadedBytes    | number     | tr_session_stats
431                              | downloadedBytes  | number     | tr_session_stats
432                              | filesAdded       | number     | tr_session_stats
433                              | sessionCount     | number     | tr_session_stats
434                              | secondsActive    | number     | tr_session_stats
435
4364.3.  Blocklist
437
438   Method name: "blocklist-update"
439   Request arguments: none
440   Response arguments: "blocklist-size"
441   
442
4435.0.  Protocol Versions
444
445  The following changes have been made to the RPC interface:
446
447   RPC   | Release | Backwards |                |
448   Vers. | Version | Compat?   | Method         | Description
449   ------+---------+-----------+----------------+-------------------------------
450   1     | 1.30    | n/a       | n/a            | Initial version
451   ------+---------+-----------+----------------+-------------------------------
452   2     | 1.34    | yes       | torrent-get    | new arg "peers"
453   ------+---------+-----------+----------------+-------------------------------
454   3     | 1.41    | yes       | torrent-get    | added "port" to "peers"
455         |         | yes       | torrent-get    | new arg "downloaders"
456         |         | yes       | session-get    | new arg "version"
457         |         | yes       | torrent-remove | new method
458   ------+---------+-----------+----------------+-------------------------------
459   4     | 1.50    | yes       | session-get    | new arg "rpc-version"
460         |         | yes       | session-get    | new arg "rpc-version-minimum"
461         |         | yes       | session-stats  | added "cumulative-stats"
462         |         | yes       | session-stats  | added "current-stats"
463         |         | yes       | torrent-get    | new arg "downloadDir"
464   ------+---------+-----------+----------------+-------------------------------
465   6     | 1.60    | yes       | torrent-get    | new arg "pieces"
466         |         | yes       | torrent-get    | new arg "fileStats"
467         |         | yes       | torrent-set    | new arg "ratio"
468         |         | yes       | torrent-set    | new arg "downloadLimited"
469         |         | yes       | torrent-set    | new arg "uploadLimited"
470         |         | yes       | torrent-set    | new arg "honorsSessionLimits"
471         |         | yes       | torrent-add    | new arg "files-wanted"
472         |         | yes       | torrent-add    | new arg "files-unwanted"
473         |         | yes       | torrent-add    | new arg "priority-high"
474         |         | yes       | torrent-add    | new arg "priority-low"
475         |         | yes       | torrent-add    | new arg "priority-normal"
476         |         | yes       | session-get    | new arg "seedRatioLimit"
477         |         | yes       | session-get    | new arg "seedRatioLimited"
478         |         | yes       | session-get    | new arg "alt-speed-enabled"
479         |         | yes       | session-get    | new arg "alt-speed-time-enabled"
480         |         | yes       | session-get    | new arg "alt-speed-up"
481         |         | yes       | session-get    | new arg "alt-speed-down"
482         |         | yes       | session-get    | new arg "alt-speed-begin"
483         |         | yes       | session-get    | new arg "alt-speed-end"
484         |         | yes       | session-get    | new arg "blocklist-enabled"
485         |         | yes       | session-get    | new arg "blocklist-size"
486         |         | yes       | session-get    | new arg "peer-limit-per-torrent"
487         |         | yes       | torrent-get    | new arg "seedRatioLimit"
488         |         | yes       | torrent-get    | new arg "seedRatioMode"
489         |         | yes       | torrent-get    | new arg "torrentFile"
490         |         | yes       | torrent-get    | new ids option "recently-active"
491         |         | yes       | torrent-get    | new ids option "percentDone"
492         |         | yes       |                | new method "torrent-reannounce"
493         |         | yes       |                | new method "blocklist-update"
494         |         |        NO | torrent-get    | removed arg "downloadLimitMode"
495         |         |        NO | torrent-get    | removed arg "uploadLimitMode"
496         |         |        NO | session-get    | renamed "pex-allowed" to "pex-enabled"
497         |         |        NO | session-get    | renamed "port" to "peer-port"
498         |         |        NO | session-get    | renamed "peer-limit" to "peer-limit-global"
499   ------+---------+-----------+----------------+-------------------------------
500
501
Note: See TracBrowser for help on using the repository browser.