torrents.get

Gets the information of a single torrents.

Request

Example

{
  "info_hash": [ "abcdef0123456789abcd", null ],

  // Optional session ID. If not specified, will look in the session
  // named 'default'.
  "session_id": 7
}

Response

{
  "torrent": {
    // the number of seconds this torrent has spent in the session and not
    // been paused
    "active_duration": 18,

    // the total rates for all peers for this torrent. These will usually
    // have better precision than summing the rates from all peers. The rates
    // are given as the number of bytes per second.
    "download_rate": 788,
    "upload_rate": 123,

    // the number of seconds this torrent had all _selected_ files and pieces
    // downloaded and available to other peers.
    "finished_duration": 0,

    // reflects several of the torrent's flags
    "flags": 129,

    // the torrents info hash
    "info_hash": [ "", null ],

    // the number of seeds in our peer list and the total number of peers
    // (including seeds). We are not necessarily connected to all the peers
    // in our peer list. This is the number of peers we know of in total,
    // including banned peers and peers that we have failed to connect to.
    "list_peers": 87,
    "list_seeds": 89,

    // the name of the torrent. Typically this is derived from the
    // .torrent file. In case the torrent was started without metadata,
    // and hasn't completely received it yet, it returns the name given
    // to it when added to the session.
    "name": "ubuntu",

    // the number of peers this torrent currently is connected to. Peer
    // connections that are in the half-open state (is attempting to connect)
    // or are queued for later connection attempt do not count. Although they
    // are visible in the peer list
    "num_peers": 898,

    // the number of peers that are seeding that this client is
    // currently connected to.
    "num_seeds": 76,

    // a value in the range [0, 1], that represents the progress of the
    // torrent's current task. It may be checking files or downloading.
    "progress": 0.54487,

    // the position this torrent has in the download queue. If the torrent is
    // a seed or finished, this is -1.
    "queue_position": 9,

    // the current ratio of the torrent. this is calculated by doing
    // all_time_upload / all_time_download
    "ratio": 0.543,

    // the path to the directory where this torrent's files are stored.
    "save_path": "/dl/my-stuff",

    // the number of seconds this torrent had _all_ files and pieces downloaded
    // and available to other peers.
    "seeding_duration": 67,

    // the total number of bytes the torrent-file represents. Note that this
    // is the number of pieces times the piece size (modulo the last piece
    // possibly being smaller). With pad files, the total size will be larger
    // than the sum of all (regular) file sizes.
    "size": 87677,

    // the total number of bytes to download for this torrent. This may be
    // less than the size of the torrent in case there are pad files. This
    // number only counts bytes that will actually be requested from peers.
    "total": 887,

    // the total number of bytes of the file(s) that we have. All this does
    // not necessarily has to be downloaded during this session (that's
    // ``total_payload_download``).
    "total_done": 766,
  }
}