Tsarr Documentation - v2.11.0
    Preparing search index...

    Type Alias TorrentInfo

    type TorrentInfo = {
        added_on?: number;
        amount_left?: number;
        auto_tmm?: boolean;
        availability?: number;
        category?: string;
        completed?: number;
        completion_on?: number;
        content_path?: string;
        dl_limit?: number;
        dlspeed?: number;
        downloaded?: number;
        downloaded_session?: number;
        eta?: number;
        f_l_piece_prio?: boolean;
        force_start?: boolean;
        hash?: string;
        last_activity?: number;
        magnet_uri?: string;
        max_ratio?: number;
        max_seeding_time?: number;
        name?: string;
        num_complete?: number;
        num_incomplete?: number;
        num_leechs?: number;
        num_seeds?: number;
        priority?: number;
        progress?: number;
        ratio?: number;
        ratio_limit?: number;
        save_path?: string;
        seeding_time?: number;
        seeding_time_limit?: number;
        seen_complete?: number;
        seq_dl?: boolean;
        size?: number;
        state?:
            | "error"
            | "missingFiles"
            | "uploading"
            | "pausedUP"
            | "queuedUP"
            | "stalledUP"
            | "checkingUP"
            | "forcedUP"
            | "allocating"
            | "downloading"
            | "metaDL"
            | "pausedDL"
            | "queuedDL"
            | "stalledDL"
            | "checkingDL"
            | "forcedDL"
            | "checkingResumeData"
            | "moving"
            | "unknown";
        super_seeding?: boolean;
        tags?: string;
        time_active?: number;
        total_size?: number;
        tracker?: string;
        up_limit?: number;
        uploaded?: number;
        uploaded_session?: number;
        upspeed?: number;
    }
    Index

    Properties

    added_on? amount_left? auto_tmm? availability? category? completed? completion_on? content_path? dl_limit? dlspeed? downloaded? downloaded_session? eta? f_l_piece_prio? force_start? hash? last_activity? magnet_uri? max_ratio? max_seeding_time? name? num_complete? num_incomplete? num_leechs? num_seeds? priority? progress? ratio? ratio_limit? save_path? seeding_time? seeding_time_limit? seen_complete? seq_dl? size? state? super_seeding? tags? time_active? total_size? tracker? up_limit? uploaded? uploaded_session? upspeed?

    Properties

    added_on?: number

    Time (Unix Epoch) when the torrent was added to the client

    amount_left?: number

    Amount of data left to download (bytes)

    auto_tmm?: boolean

    Whether this torrent is managed by Automatic Torrent Management

    availability?: number

    Percentage of file pieces currently available

    category?: string

    Category of the torrent

    completed?: number

    Amount of transfer data completed (bytes)

    completion_on?: number

    Time (Unix Epoch) when the torrent completed

    Optionalcontent_path

    content_path?: string

    Absolute path of torrent content (root path for multifile torrents, absolute file path for singlefile torrents)

    dl_limit?: number

    Torrent download speed limit (bytes/s). -1 if ulimited.

    dlspeed?: number

    Torrent download speed (bytes/s)

    downloaded?: number

    Amount of data downloaded

    downloaded_session?: number

    Amount of data downloaded this session

    eta?: number

    Torrent ETA (seconds)

    f_l_piece_prio?: boolean

    True if first last piece are prioritized

    force_start?: boolean

    True if force start is enabled for this torrent

    hash?: string

    Torrent hash

    last_activity?: number

    Last time (Unix Epoch) when a chunk was downloaded/uploaded

    magnet_uri?: string

    Magnet URI corresponding to this torrent

    max_ratio?: number

    Maximum share ratio until torrent is stopped from seeding/uploading

    max_seeding_time?: number

    Maximum seeding time (seconds) until torrent is stopped from seeding

    name?: string

    Torrent name

    num_complete?: number

    Number of seeds in the swarm

    num_incomplete?: number

    Number of leechers in the swarm

    num_leechs?: number

    Number of leechers connected to

    num_seeds?: number

    Number of seeds connected to

    priority?: number

    Torrent priority. Returns -1 if queuing is disabled or torrent is in seed mode

    progress?: number

    Torrent progress (percentage/100)

    ratio?: number

    Torrent share ratio. Max ratio value: 9999.

    ratio_limit?: number

    TODO (what is different from max_ratio?)

    save_path?: string

    Path where this torrent's data is stored

    seeding_time?: number

    Torrent elapsed time while complete (seconds)

    seeding_time_limit?: number

    TODO (what is different from max_seeding_time?) seeding_time_limit is a per torrent setting, when Automatic Torrent Management is disabled, furthermore then max_seeding_time is set to seeding_time_limit for this torrent. If Automatic Torrent Management is enabled, the value is -2. And if max_seeding_time is unset it have a default value -1.

    seen_complete?: number

    Time (Unix Epoch) when this torrent was last seen complete

    seq_dl?: boolean

    True if sequential download is enabled

    size?: number

    Total size (bytes) of files selected for download

    state?:
        | "error"
        | "missingFiles"
        | "uploading"
        | "pausedUP"
        | "queuedUP"
        | "stalledUP"
        | "checkingUP"
        | "forcedUP"
        | "allocating"
        | "downloading"
        | "metaDL"
        | "pausedDL"
        | "queuedDL"
        | "stalledDL"
        | "checkingDL"
        | "forcedDL"
        | "checkingResumeData"
        | "moving"
        | "unknown"

    Torrent state. See table here below for the possible values

    Value Description
    error Some error occurred, applies to paused torrents
    missingFiles Torrent data files is missing
    uploading Torrent is being seeded and data is being transferred
    pausedUP Torrent is paused and has finished downloading
    queuedUP Queuing is enabled and torrent is queued for upload
    stalledUP Torrent is being seeded, but no connection were made
    checkingUP Torrent has finished downloading and is being checked
    forcedUP Torrent is forced to uploading and ignore queue limit
    allocating Torrent is allocating disk space for download
    downloading Torrent is being downloaded and data is being transferred
    metaDL Torrent has just started downloading and is fetching metadata
    pausedDL Torrent is paused and has NOT finished downloading
    queuedDL Queuing is enabled and torrent is queued for download
    stalledDL Torrent is being downloaded, but no connection were made
    checkingDL Same as checkingUP, but torrent has NOT finished downloading
    forcedDL Torrent is forced to downloading to ignore queue limit
    checkingResumeData Checking resume data on qBt startup
    moving Torrent is moving to another location
    unknown Unknown status
    super_seeding?: boolean

    True if super seeding is enabled

    tags?: string

    Comma-concatenated tag list of the torrent

    time_active?: number

    Total active time (seconds)

    total_size?: number

    Total size (bytes) of all file in this torrent (including unselected ones)

    tracker?: string

    The first tracker with working status. Returns empty string if no tracker is working.

    up_limit?: number

    Torrent upload speed limit (bytes/s). -1 if ulimited.

    uploaded?: number

    Amount of data uploaded

    uploaded_session?: number

    Amount of data uploaded this session

    upspeed?: number

    Torrent upload speed (bytes/s)

    Settings

    Member Visibility

    On This Page

    Properties