@ctrl/qbittorrent
    Preparing search index...

    Interface Torrent

    interface Torrent {
        added_on: number;
        amount_left: number;
        auto_tmm: boolean;
        availability: number;
        category: string;
        comment?: string;
        completed: number;
        completion_on: number;
        connections_count?: number;
        connections_limit?: number;
        content_path: string;
        created_by?: string;
        creation_date?: number;
        dl_limit: number;
        dlspeed: number;
        download_path?: string;
        downloaded: number;
        downloaded_session: number;
        eta: number;
        f_l_piece_prio: boolean;
        files?: TorrentFile[];
        force_start: boolean;
        has_metadata?: boolean;
        has_other_announce_error?: boolean;
        has_tracker_error?: boolean;
        has_tracker_warning?: boolean;
        hash: string;
        inactive_seeding_time_limit?: number;
        infohash_v1?: string;
        infohash_v2?: string;
        last_activity: number;
        magnet_uri: string;
        max_inactive_seeding_time?: number;
        max_ratio: number;
        max_seeding_time: number;
        name: string;
        num_complete: number;
        num_incomplete: number;
        num_leechs: number;
        num_seeds: number;
        piece_size?: number;
        pieces_have?: number;
        pieces_num?: number;
        popularity?: number;
        priority: number;
        private?: boolean | null;
        progress: number;
        ratio: number;
        ratio_limit: number;
        reannounce?: number;
        root_path?: string;
        save_path: string;
        seeding_time: number;
        seeding_time_limit: number;
        seen_complete: number;
        seq_dl: boolean;
        share_limit_action?: string;
        share_limits_mode?: "Default" | "MatchAny" | "MatchAll";
        size: number;
        state: TorrentState;
        super_seeding: boolean;
        tags: string;
        time_active: number;
        total_size: number;
        total_wasted?: number;
        tracker: string;
        trackers_count: number;
        up_limit: number;
        uploaded: number;
        uploaded_session: number;
        upspeed: number;
    }
    Index
    added_on amount_left auto_tmm availability category comment? completed completion_on connections_count? connections_limit? content_path created_by? creation_date? dl_limit dlspeed download_path? downloaded downloaded_session eta f_l_piece_prio files? force_start has_metadata? has_other_announce_error? has_tracker_error? has_tracker_warning? hash inactive_seeding_time_limit? infohash_v1? infohash_v2? last_activity magnet_uri max_inactive_seeding_time? max_ratio max_seeding_time name num_complete num_incomplete num_leechs num_seeds piece_size? pieces_have? pieces_num? popularity? priority private? progress ratio ratio_limit reannounce? root_path? save_path seeding_time seeding_time_limit seen_complete seq_dl share_limit_action? share_limits_mode? size state super_seeding tags time_active total_size total_wasted? tracker trackers_count up_limit uploaded uploaded_session upspeed
    added_on: number

    datetime in seconds

    amount_left: number

    Amount of data left to download

    auto_tmm: boolean

    Whether this torrent is managed by Automatic Torrent Management

    availability: number

    Percentage of file pieces currently available Added in qBittorrent WebUI API v2.2.0

    category: string

    Category name

    comment?: string

    Torrent comment from the .torrent file

    completed: number

    Amount of data completed

    completion_on: number

    Torrent copletion datetime in seconds

    connections_count?: number
    connections_limit?: number

    content_path

    content_path: string

    Absolute path of torrent content (root path for multifile torrents, absolute file path for singlefile torrents) Added in qBittorrent WebUI API v2.6.1

    created_by?: string

    Torrent creator from the .torrent file

    creation_date?: number

    When the .torrent file was created, unix seconds

    dl_limit: number

    Torrent download limit

    dlspeed: number

    Torrent download speed (bytes/s)

    download_path?: string
    downloaded: number

    Amount of data downloaded

    downloaded_session: number

    Amount of data downloaded since program open

    eta: number

    Torrent ETA

    f_l_piece_prio: boolean

    Torrent first last piece priority state

    files?: TorrentFile[]

    Included when includeFiles is passed to /torrents/info Added in qBittorrent WebUI API v2.11.8 https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2118

    force_start: boolean

    True if force start is enabled for this torrent

    has_metadata?: boolean
    has_other_announce_error?: boolean

    True when the torrent has a non-tracker announce error Added in qBittorrent WebUI API v2.11.7 https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2117

    has_tracker_error?: boolean

    True when at least one tracker has an error Added in qBittorrent WebUI API v2.11.7 https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2117

    has_tracker_warning?: boolean

    True when at least one tracker has a warning Added in qBittorrent WebUI API v2.11.7 https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2117

    hash: string
    inactive_seeding_time_limit?: number

    Minutes, -2 global limit, -1 unlimited

    infohash_v1?: string
    infohash_v2?: string

    Empty for v1 only torrents

    last_activity: number

    Last time when a chunk was downloaded/uploaded

    magnet_uri: string
    max_inactive_seeding_time?: number
    max_ratio: number

    Upload max share ratio

    max_seeding_time: number

    Upload max seeding time

    name: string

    Torrent name

    num_complete: number

    Torrent seeds in the swarm

    num_incomplete: number

    Torrent leechers in the swarm

    num_leechs: number

    Torrent leechers connected to

    num_seeds: number

    Torrent seeds connected to

    piece_size?: number
    pieces_have?: number
    pieces_num?: number
    popularity?: number

    Ratio / time active in months

    priority: number

    Torrent priority (-1 if queuing is disabled)

    private?: boolean | null

    Null until metadata is available

    progress: number

    Torrent progress

    ratio: number

    Torrent share ratio

    ratio_limit: number

    Upload share ratio limit

    reannounce?: number

    Time until the next tracker reannounce Added in qBittorrent WebUI API v2.9.3 (qb v5.0.0)

    root_path?: string

    Content root path, empty until metadata is available

    save_path: string

    Torrent save path

    seeding_time: number

    Torrent elapsed time while complete (seconds) Added in qBittorrent WebUI API v2.8.1

    seeding_time_limit: number

    Upload seeding time limit

    seen_complete: number

    Indicates the time when the torrent was last seen complete/whole

    seq_dl: boolean

    Torrent sequential download state

    share_limit_action?: string

    Share limit action for this torrent Added in qBittorrent WebUI API v2.12.0 https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2120

    share_limits_mode?: "Default" | "MatchAny" | "MatchAll"

    WebAPI 2.15.3+

    size: number

    Torrent size

    state: TorrentState

    Torrent state

    super_seeding: boolean

    True if super seeding is enabled

    tags: string

    Comma-concatenated tag list of the torrent e.g. - "abc, 123"

    time_active: number
    total_size: number

    Size including unwanted data

    total_wasted?: number

    Bytes wasted on bad or redundant data

    tracker: string

    Torrent tracker

    trackers_count: number
    up_limit: number

    Torrent upload limit

    uploaded: number

    Amount of data uploaded

    uploaded_session: number

    Amount of data uploaded since program open

    upspeed: number

    Torrent upload speed (bytes/s)

    Settings
    Member Visibility

    On This Page
    Properties