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

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

(trunk rpc) added "fileStats" to rpc s.t. there's a simple interface for getting all the torrent's stat fields

File size: 24.9 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   uploadedEver                    | number                      | tr_stat
201   uploadLimit                     | number                      | tr_torrent
202   uploadLimited                   | 'boolean'                   | tr_torrent
203   uploadRatio                     | 'double'                    | tr_stat
204   wanted                          | array (see below)           | n/a
205   webseeds                        | array (see below)           | n/a
206   webseedsSendingToUs             | number                      | tr_stat
207                                   |                             |
208                                   |                             |
209   -----------------------+--------+-----------------------------+
210   files                  | array of objects, each containing:   |
211                          +-------------------------+------------+
212                          | key                     | type       |
213                          | bytesCompleted          | number     | tr_torrent
214                          | length                  | number     | tr_info
215                          | name                    | string     | tr_info
216   -----------------------+--------------------------------------+
217   fileStats              | a file's non-constant properties.    |
218                          | array of tr_info.filecount objects,  |
219                          | each containing:                     |
220                          +-------------------------+------------+
221                          | bytesCompleted          | number     | tr_torrent
222                          | wanted                  | 'boolean'  | tr_info
223                          | priority                | number     | tr_info
224   -----------------------+--------------------------------------+
225   peers                  | array of objects, each containing:   |
226                          +-------------------------+------------+
227                          | address                 | string     | tr_peer_stat
228                          | clientName              | string     | tr_peer_stat
229                          | clientIsChoked          | 'boolean'  | tr_peer_stat
230                          | clientIsInterested      | 'boolean'  | tr_peer_stat
231                          | isDownloadingFrom       | 'boolean'  | tr_peer_stat
232                          | isEncrypted             | 'boolean'  | tr_peer_stat
233                          | isIncoming              | 'boolean'  | tr_peer_stat
234                          | isUploadingTo           | 'boolean'  | tr_peer_stat
235                          | peerIsChoked            | 'boolean'  | tr_peer_stat
236                          | peerIsInterested        | 'boolean'  | tr_peer_stat
237                          | port                    | number     | tr_peer_stat
238                          | progress                | 'double'   | tr_peer_stat
239                          | rateToClient (B/s)      | number     | tr_peer_stat
240                          | rateToPeer (B/s)        | number     | tr_peer_stat
241   -----------------------+--------------------------------------+
242   peersFrom              | an object containing:                |
243                          +-------------------------+------------+
244                          | fromCache               | number     | tr_stat
245                          | fromIncoming            | number     | tr_stat
246                          | fromPex                 | number     | tr_stat
247                          | fromTracker             | number     | tr_stat
248   -----------------------+--------------------------------------+
249   pieces                 | A bitfield holding pieceCount flags  | tr_torrent
250                          | which are set to 'true' if we have   |
251                          | the piece matching that position.    |
252                          | JSON doesn't allow raw binary data,  |
253                          | so this is a base64-encoded string.  |
254   -----------------------+--------------------------------------+
255   priorities             | an array of tr_info.filecount        | tr_info
256                          | numbers. each is the tr_priority_t   |
257                          | mode for the corresponding file.     |
258   -----------------------+--------------------------------------+
259   trackers               | array of objects, each containing:   |
260                          +-------------------------+------------+
261                          | announce                | string     | tr_info
262                          | scrape                  | string     | tr_info
263                          | tier                    | number     | tr_info
264   -----------------------+--------------------------------------+
265   wanted                 | an array of tr_info.fileCount        | tr_info
266                          | 'booleans' true if the corresponding |
267                          | file is to be downloaded.            |
268   -----------------------+--------------------------------------+
269   webseeds               | an array of strings:                 |
270                          +-------------------------+------------+
271                          | webseed                 | string     | tr_info
272                          +-------------------------+------------+
273
274   Example:
275
276   Say we want to get the name and total size of torrents #7 and #10.
277
278   Request:
279
280      {
281         "arguments": {
282             "fields": [ "id", "name", "totalSize" ],
283             "ids": [ 7, 10 ]
284         },
285         "method": "torrent-get",
286         "tag": 39693
287      }
288
289
290   Response:
291
292      {
293         "arguments": {
294            "torrents": [
295               {
296                   "id": 10,
297                   "name": "Fedora x86_64 DVD",
298                   "totalSize", 34983493932,
299               },
300               {
301                   "id": 7,
302                   "name": "Ubuntu x86_64 DVD",
303                   "totalSize", 9923890123,
304               }
305            ]
306         },
307         "result": "success",
308         "tag": 39693
309      }
310
3113.4.  Adding a Torrent
312
313   Method name: "torrent-add"
314
315   Request arguments:
316
317   key                | value type & description
318   -------------------+-------------------------------------------------
319   "download-dir"     | string      path to download the torrent to
320   "filename"         | string      filename or URL of the .torrent file
321   "metainfo"         | string      base64-encoded .torrent content
322   "paused"           | 'boolean'   if true, don't start the torrent
323   "peer-limit"       | number      maximum number of peers
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-up"             | number     max global upload speed (in K/s)
358   "blocklist-enabled"        | 'boolean'  true means enabled
359   "blocklist-size"           | number     number of rules in the blocklist
360   "encryption"               | string     "required", "preferred", "tolerated"
361   "download-dir"             | string     default path to download torrents
362   "peer-limit-global"        | number     maximum global number of peers
363   "peer-limit-per-torrent"   | number     maximum global number of peers
364   "pex-enabled"              | 'boolean'  true means allow pex in public torrents
365   "peer-port"                | number     port number
366   "port-forwarding-enabled"  | 'boolean'  true means enabled
367   "rpc-version"              | number     the current RPC API version
368   "rpc-version-minimum"      | number     the minimum RPC API version supported
369   "speed-limit-down"         | number     max global download speed (in K/s)
370   "speed-limit-down-enabled" | 'boolean'  true means enabled
371   "speed-limit-up"           | number     max global upload speed (in K/s)
372   "speed-limit-up-enabled"   | 'boolean'  true means enabled
373   "version"                  | string     long version string "$version ($revision)"
374
375   "rpc-version" indicates the RPC interface version supported by the RPC server.
376   It is incremented when a new version of Transmission changes the RPC interface.
377
378   "rpc-version-minimum" indicates the oldest API supported by the RPC server.
379   It is changes when a new version of Transmission changes the RPC interface
380   in a way that is not backwards compatible.  There are no plans for this
381   to be common behavior.
382
3834.1.1.  Mutators
384
385   Method name: "session-set"
386   Request arguments: one or more of 4.1's arguments, except: "blocklist-size",
387                      "rpc-version", "rpc-version-minimum", and "version"
388   Response arguments: none
389
3904.1.2.  Accessors
391
392   Method name: "session-get"
393   Request arguments: none
394   Response arguments: all of 4.1's arguments
395
3964.2.  Session Statistics
397
398   Method name: "session-stats"
399
400   Request arguments: none
401
402   Response arguments:
403
404   string                     | value type
405   ---------------------------+-------------------------------------------------
406   "activeTorrentCount"       | number
407   "downloadSpeed"            | number
408   "pausedTorrentCount"       | number
409   "torrentCount"             | number
410   "uploadSpeed"              | number
411   ---------------------------+-------------------------------+
412   "cumulative-stats"         | object, containing:           |
413                              +------------------+------------+
414                              | uploadedBytes    | number     | tr_session_stats
415                              | downloadedBytes  | number     | tr_session_stats
416                              | filesAdded       | number     | tr_session_stats
417                              | sessionCount     | number     | tr_session_stats
418                              | secondsActive    | number     | tr_session_stats
419   ---------------------------+-------------------------------+
420   "current-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
4295.0.  Protocol Versions
430
431  The following changes have been made to the RPC interface:
432
433   RPC   | Release | Backwards |                |
434   Vers. | Version | Compat?   | Method         | Description
435   ------+---------+-----------+----------------+-------------------------------
436   1     | 1.30    | n/a       | n/a            | Initial version
437   ------+---------+-----------+----------------+-------------------------------
438   2     | 1.34    | yes       | torrent-get    | new arg "peers"
439   ------+---------+-----------+----------------+-------------------------------
440   3     | 1.41    | yes       | torrent-get    | added "port" to "peers"
441         |         | yes       | torrent-get    | new arg "downloaders"
442         |         | yes       | session-get    | new arg "version"
443         |         | yes       | torrent-remove | new method
444   ------+---------+-----------+----------------+-------------------------------
445   4     | 1.50    | yes       | session-get    | new arg "rpc-version"
446         |         | yes       | session-get    | new arg "rpc-version-minimum"
447         |         | yes       | session-stats  | added "cumulative-stats"
448         |         | yes       | session-stats  | added "current-stats"
449         |         | yes       | torrent-get    | new arg "downloadDir"
450   ------+---------+-----------+----------------+-------------------------------
451   6     | 1.60    | yes       | torrent-get    | new arg "pieces"
452         |         | yes       | torrent-get    | new arg "fileStats"
453         |         | yes       | torrent-set    | new arg "ratio"
454         |         | yes       | torrent-set    | new arg "downloadLimited"
455         |         | yes       | torrent-set    | new arg "uploadLimited"
456         |         | yes       | torrent-set    | new arg "honorsSessionLimits"
457         |         | yes       | session-get    | new arg "seedRatioLimit"
458         |         | yes       | session-get    | new arg "seedRatioLimited"
459         |         | yes       | session-get    | new arg "alt-speed-enabled"
460         |         | yes       | session-get    | new arg "alt-speed-time-enabled"
461         |         | yes       | session-get    | new arg "alt-speed-up"
462         |         | yes       | session-get    | new arg "alt-speed-down"
463         |         | yes       | session-get    | new arg "alt-speed-begin"
464         |         | yes       | session-get    | new arg "alt-speed-end"
465         |         | yes       | session-get    | new arg "blocklist-enabled"
466         |         | yes       | session-get    | new arg "blocklist-size"
467         |         | yes       | session-get    | new arg "peer-limit-per-torrent"
468         |         | yes       | torrent-get    | new arg "seedRatioLimit"
469         |         | yes       | torrent-get    | new arg "seedRatioMode"
470         |         | yes       | torrent-get    | new ids option "recently-active"
471         |         | yes       | torrent-get    | new ids option "percentDone"
472         |         | yes       |                | new method "torrent-reannounce"
473         |         |        NO | torrent-get    | removed arg "downloadLimitMode"
474         |         |        NO | torrent-get    | removed arg "uploadLimitMode"
475         |         |        NO | session-get    | renamed "pex-allowed" to "pex-enabled"
476         |         |        NO | session-get    | renamed "port" to "peer-port"
477         |         |        NO | session-get    | renamed "peer-limit" to "peer-limit-global"
478   ------+---------+-----------+----------------+-------------------------------
479
480
Note: See TracBrowser for help on using the repository browser.