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

Last change on this file since 8154 was 8154, checked in by charles, 13 years ago

(trunk) Use proper notation for json floating-point and bool types. For backwards compatability, still allow old-style printf strings as doubles, and 0s and 1s as bools.

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