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

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

(trunk) add arg "percentDone" to RPC "torrentGet"

File size: 24.2 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   hashString                      | string                      | tr_info
157   haveUnchecked                   | number                      | tr_stat
158   haveValid                       | number                      | tr_stat
159   honorsSessionLimits             | 'boolean'                   | tr_torrent
160   id                              | number                      | tr_torrent
161   isPrivate                       | 'boolean'                   | tr_torrent
162   lastAnnounceTime                | number                      | tr_stat
163   lastScrapeTime                  | number                      | tr_stat
164   leechers                        | number                      | tr_stat
165   leftUntilDone                   | number                      | tr_stat
166   manualAnnounceTime              | number                      | tr_stat
167   maxConnectedPeers               | number                      | tr_torrent
168   name                            | string                      | tr_info
169   nextAnnounceTime                | number                      | tr_stat
170   nextScrapeTime                  | number                      | tr_stat
171   peer-limit                      | number                      | tr_torrent
172   peers                           | array (see below)           | n/a
173   peersConnected                  | number                      | tr_stat
174   peersFrom                       | object (see below)          | n/a
175   peersGettingFromUs              | number                      | tr_stat
176   peersKnown                      | number                      | tr_stat
177   peersSendingToUs                | number                      | tr_stat
178   percentDone                     | 'double'                    | tr_stat
179   pieces                          | string (see below)          | tr_torrent
180   pieceCount                      | tnumber                     | tr_info
181   pieceSize                       | tnumber                     | tr_info
182   priorities                      | array (see below)           | n/a
183   ratio                           | 'double'                    | tr_stat
184   rateDownload (B/s)              | number                      | tr_stat
185   rateUpload (B/s)                | number                      | tr_stat
186   recheckProgress                 | 'double'                    | tr_stat
187   scrapeResponse                  | string                      | tr_stat
188   scrapeURL                       | string                      | tr_stat
189   seeders                         | number                      | tr_stat
190   seedRatioLimit                  | 'double'                    | tr_torrent
191   seedRatioMode                   | number                      | tr_ratiolimit
192   sizeWhenDone                    | number                      | tr_stat
193   startDate                       | number                      | tr_stat
194   status                          | number                      | tr_stat
195   swarmSpeed (K/s)                | number                      | tr_stat
196   timesCompleted                  | number                      | tr_stat
197   trackers                        | array (see below)           | n/a
198   totalSize                       | number                      | tr_info
199   uploadedEver                    | number                      | tr_stat
200   uploadLimit                     | number                      | tr_torrent
201   uploadLimited                   | 'boolean'                   | tr_torrent
202   uploadRatio                     | 'double'                    | tr_stat
203   wanted                          | array (see below)           | n/a
204   webseeds                        | array (see below)           | n/a
205   webseedsSendingToUs             | number                      | tr_stat
206                                   |                             |
207                                   |                             |
208   -----------------------+--------+-----------------------------+
209   files                  | array of objects, each containing:   |
210                          +-------------------------+------------+
211                          | key                     | type       |
212                          | bytesCompleted          | number     | tr_torrent
213                          | length                  | number     | tr_info
214                          | name                    | string     | tr_info
215   -----------------------+--------------------------------------+
216   peers                  | array of objects, each containing:   |
217                          +-------------------------+------------+
218                          | address                 | string     | tr_peer_stat
219                          | clientName              | string     | tr_peer_stat
220                          | clientIsChoked          | 'boolean'  | tr_peer_stat
221                          | clientIsInterested      | 'boolean'  | tr_peer_stat
222                          | isDownloadingFrom       | 'boolean'  | tr_peer_stat
223                          | isEncrypted             | 'boolean'  | tr_peer_stat
224                          | isIncoming              | 'boolean'  | tr_peer_stat
225                          | isUploadingTo           | 'boolean'  | tr_peer_stat
226                          | peerIsChoked            | 'boolean'  | tr_peer_stat
227                          | peerIsInterested        | 'boolean'  | tr_peer_stat
228                          | port                    | number     | tr_peer_stat
229                          | progress                | 'double'   | tr_peer_stat
230                          | rateToClient (B/s)      | number     | tr_peer_stat
231                          | rateToPeer (B/s)        | number     | tr_peer_stat
232   -----------------------+--------------------------------------+
233   peersFrom              | an object containing:                |
234                          +-------------------------+------------+
235                          | fromCache               | number     | tr_stat
236                          | fromIncoming            | number     | tr_stat
237                          | fromPex                 | number     | tr_stat
238                          | fromTracker             | number     | tr_stat
239   -----------------------+--------------------------------------+
240   pieces                 | A bitfield holding pieceCount flags  | tr_torrent
241                          | which are set to 'true' if we have   |
242                          | the piece matching that position.    |
243                          | JSON doesn't allow raw binary data,  |
244                          | so this is a base64-encoded string.  |
245   -----------------------+--------------------------------------+
246   priorities             | an array of tr_info.filecount        | tr_info
247                          | numbers. each is the tr_priority_t   |
248                          | mode for the corresponding file.     |
249   -----------------------+--------------------------------------+
250   trackers               | array of objects, each containing:   |
251                          +-------------------------+------------+
252                          | announce                | string     | tr_info
253                          | scrape                  | string     | tr_info
254                          | tier                    | number     | tr_info
255   -----------------------+--------------------------------------+
256   wanted                 | an array of tr_info.fileCount        | tr_info
257                          | 'booleans' true if the corresponding |
258                          | file is to be downloaded.            |
259   -----------------------+--------------------------------------+
260   webseeds               | an array of strings:                 |
261                          +-------------------------+------------+
262                          | webseed                 | string     | tr_info
263                          +-------------------------+------------+
264
265   Example:
266
267   Say we want to get the name and total size of torrents #7 and #10.
268
269   Request:
270
271      {
272         "arguments": {
273             "fields": [ "id", "name", "totalSize" ],
274             "ids": [ 7, 10 ]
275         },
276         "method": "torrent-get",
277         "tag": 39693
278      }
279
280
281   Response:
282
283      {
284         "arguments": {
285            "torrents": [
286               {
287                   "id": 10,
288                   "name": "Fedora x86_64 DVD",
289                   "totalSize", 34983493932,
290               },
291               {
292                   "id": 7,
293                   "name": "Ubuntu x86_64 DVD",
294                   "totalSize", 9923890123,
295               }
296            ]
297         },
298         "result": "success",
299         "tag": 39693
300      }
301
3023.4.  Adding a Torrent
303
304   Method name: "torrent-add"
305
306   Request arguments:
307
308   key                | value type & description
309   -------------------+-------------------------------------------------
310   "download-dir"     | string      path to download the torrent to
311   "filename"         | string      filename or URL of the .torrent file
312   "metainfo"         | string      base64-encoded .torrent content
313   "paused"           | 'boolean'   if true, don't start the torrent
314   "peer-limit"       | number      maximum number of peers
315
316   Either "filename" OR "metainfo" MUST be included.
317   All other arguments are optional.
318
319   Response arguments: on success, a "torrent-added" object in the
320                       form of one of 3.3's tr_info objects with the
321                       fields for id, name, and hashString.
322
3233.5.  Removing a Torrent
324
325   Method name: "torrent-remove"
326
327   Request arguments:
328
329   string                     | value type & description
330   ---------------------------+-------------------------------------------------
331   "ids"                      | array      torrent list, as described in 3.1
332   "delete-local-data"        | 'boolean'  delete local data. (default: false)
333
334   Response arguments: none
335
336
3374.   Session Requests
338
3394.1.  Session Arguments
340
341   string                     | value type & description
342   ---------------------------+-------------------------------------------------
343   "alt-speed-down"           | number     max global download speed (in K/s)
344   "alt-speed-enabled"        | 'boolean'  true means use the alt speeds
345   "alt-speed-time-begin"     | number     when to turn on alt speeds (units: minutes after midnight)
346   "alt-speed-time-enabled"   | 'boolean'  true means the scheduled on/off times are used
347   "alt-speed-time-end"       | number     when to turn off alt speeds (units: same)
348   "alt-speed-up"             | number     max global upload speed (in K/s)
349   "blocklist-enabled"        | 'boolean'  true means enabled
350   "blocklist-size"           | number     number of rules in the blocklist
351   "encryption"               | string     "required", "preferred", "tolerated"
352   "download-dir"             | string     default path to download torrents
353   "peer-limit-global"        | number     maximum global number of peers
354   "peer-limit-per-torrent"   | number     maximum global number of peers
355   "pex-enabled"              | 'boolean'  true means allow pex in public torrents
356   "peer-port"                | number     port number
357   "port-forwarding-enabled"  | 'boolean'  true means enabled
358   "rpc-version"              | number     the current RPC API version
359   "rpc-version-minimum"      | number     the minimum RPC API version supported
360   "speed-limit-down"         | number     max global download speed (in K/s)
361   "speed-limit-down-enabled" | 'boolean'  true means enabled
362   "speed-limit-up"           | number     max global upload speed (in K/s)
363   "speed-limit-up-enabled"   | 'boolean'  true means enabled
364   "version"                  | string     long version string "$version ($revision)"
365
366   "rpc-version" indicates the RPC interface version supported by the RPC server.
367   It is incremented when a new version of Transmission changes the RPC interface.
368
369   "rpc-version-minimum" indicates the oldest API supported by the RPC server.
370   It is changes when a new version of Transmission changes the RPC interface
371   in a way that is not backwards compatible.  There are no plans for this
372   to be common behavior.
373
3744.1.1.  Mutators
375
376   Method name: "session-set"
377   Request arguments: one or more of 4.1's arguments, except: "blocklist-size",
378                      "rpc-version", "rpc-version-minimum", and "version"
379   Response arguments: none
380
3814.1.2.  Accessors
382
383   Method name: "session-get"
384   Request arguments: none
385   Response arguments: all of 4.1's arguments
386
3874.2.  Session Statistics
388
389   Method name: "session-stats"
390
391   Request arguments: none
392
393   Response arguments:
394
395   string                     | value type
396   ---------------------------+-------------------------------------------------
397   "activeTorrentCount"       | number
398   "downloadSpeed"            | number
399   "pausedTorrentCount"       | number
400   "torrentCount"             | number
401   "uploadSpeed"              | number
402   ---------------------------+-------------------------------+
403   "cumulative-stats"         | object, containing:           |
404                              +------------------+------------+
405                              | uploadedBytes    | number     | tr_session_stats
406                              | downloadedBytes  | number     | tr_session_stats
407                              | filesAdded       | number     | tr_session_stats
408                              | sessionCount     | number     | tr_session_stats
409                              | secondsActive    | number     | tr_session_stats
410   ---------------------------+-------------------------------+
411   "current-stats"            | object, containing:           |
412                              +------------------+------------+
413                              | uploadedBytes    | number     | tr_session_stats
414                              | downloadedBytes  | number     | tr_session_stats
415                              | filesAdded       | number     | tr_session_stats
416                              | sessionCount     | number     | tr_session_stats
417                              | secondsActive    | number     | tr_session_stats
418   
419
4205.0.  Protocol Versions
421
422  The following changes have been made to the RPC interface:
423
424   RPC   | Release | Backwards |                |
425   Vers. | Version | Compat?   | Method         | Description
426   ------+---------+-----------+----------------+-------------------------------
427   1     | 1.30    | n/a       | n/a            | Initial version
428   ------+---------+-----------+----------------+-------------------------------
429   2     | 1.34    | yes       | torrent-get    | new arg "peers"
430   ------+---------+-----------+----------------+-------------------------------
431   3     | 1.41    | yes       | torrent-get    | added "port" to "peers"
432         |         | yes       | torrent-get    | new arg "downloaders"
433         |         | yes       | session-get    | new arg "version"
434         |         | yes       | torrent-remove | new method
435   ------+---------+-----------+----------------+-------------------------------
436   4     | 1.50    | yes       | session-get    | new arg "rpc-version"
437         |         | yes       | session-get    | new arg "rpc-version-minimum"
438         |         | yes       | session-stats  | added "cumulative-stats"
439         |         | yes       | session-stats  | added "current-stats"
440         |         | yes       | torrent-get    | new arg "downloadDir"
441   ------+---------+-----------+----------------+-------------------------------
442   6     | 1.60    | yes       | torrent-get    | new arg "pieces"
443         |         | yes       | torrent-set    | new arg "ratio"
444         |         | yes       | torrent-set    | new arg "downloadLimited"
445         |         | yes       | torrent-set    | new arg "uploadLimited"
446         |         | yes       | torrent-set    | new arg "honorsSessionLimits"
447         |         | yes       | session-get    | new arg "seedRatioLimit"
448         |         | yes       | session-get    | new arg "seedRatioLimited"
449         |         | yes       | session-get    | new arg "alt-speed-enabled"
450         |         | yes       | session-get    | new arg "alt-speed-time-enabled"
451         |         | yes       | session-get    | new arg "alt-speed-up"
452         |         | yes       | session-get    | new arg "alt-speed-down"
453         |         | yes       | session-get    | new arg "alt-speed-begin"
454         |         | yes       | session-get    | new arg "alt-speed-end"
455         |         | yes       | session-get    | new arg "blocklist-enabled"
456         |         | yes       | session-get    | new arg "blocklist-size"
457         |         | yes       | session-get    | new arg "peer-limit-per-torrent"
458         |         | yes       | torrent-get    | new arg "seedRatioLimit"
459         |         | yes       | torrent-get    | new arg "seedRatioMode"
460         |         | yes       | torrent-get    | new ids option "recently-active"
461         |         | yes       | torrent-get    | new ids option "percentDone"
462         |         | yes       |                | new method "torrent-reannounce"
463         |         |        NO | torrent-get    | removed arg "downloadLimitMode"
464         |         |        NO | torrent-get    | removed arg "uploadLimitMode"
465         |         |        NO | session-get    | renamed "pex-allowed" to "pex-enabled"
466         |         |        NO | session-get    | renamed "port" to "peer-port"
467         |         |        NO | session-get    | renamed "peer-limit" to "peer-limit-global"
468   ------+---------+-----------+----------------+-------------------------------
469
470
Note: See TracBrowser for help on using the repository browser.