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

    Type Alias TorrentsInfoPostData

    type TorrentsInfoPostData = {
        body: {
            filter?:
                | "all"
                | "downloading"
                | "seeding"
                | "completed"
                | "paused"
                | "active"
                | "inactive"
                | "resumed"
                | "stalled"
                | "stalled_uploading"
                | "stalled_downloading"
                | "errored";
            category?: string;
            tag?: string;
            sort?: string;
            reverse?: boolean;
            limit?: number;
            offset?: number;
            hashes?: string[];
        };
        path?: never;
        query?: never;
        url: "/torrents/info";
    }
    Index

    Properties

    Properties

    body: {
        filter?:
            | "all"
            | "downloading"
            | "seeding"
            | "completed"
            | "paused"
            | "active"
            | "inactive"
            | "resumed"
            | "stalled"
            | "stalled_uploading"
            | "stalled_downloading"
            | "errored";
        category?: string;
        tag?: string;
        sort?: string;
        reverse?: boolean;
        limit?: number;
        offset?: number;
        hashes?: string[];
    }

    Type Declaration

    • Optionalfilter?:
          | "all"
          | "downloading"
          | "seeding"
          | "completed"
          | "paused"
          | "active"
          | "inactive"
          | "resumed"
          | "stalled"
          | "stalled_uploading"
          | "stalled_downloading"
          | "errored"

      Filter torrent list by state. Allowed state filters: all, downloading, seeding, completed, paused, active, inactive, resumed, stalled, stalled_uploading, stalled_downloading, errored

    • Optionalcategory?: string

      Get torrents with the given category (empty string means "without category"; no "category" parameter means "any category" <- broken until #11748 is resolved). Remember to URL-encode the category name. For example, My category becomes My%20category

    • Optionaltag?: string

      Get torrents with the given tag (empty string means "without tag"; no "tag" parameter means "any tag". Remember to URL-encode the category name. For example, My tag becomes My%20tag

    • Optionalsort?: string

      Sort torrents by given key. They can be sorted using any field of the response's JSON array (which are documented below) as the sort key.

    • Optionalreverse?: boolean

      Enable reverse sorting. Defaults to false

    • Optionallimit?: number

      Limit the number of torrents returned

    • Optionaloffset?: number

      Set offset (if less than 0, offset from end)

    • Optionalhashes?: string[]

      Filter by hashes. Can contain multiple hashes separated by |

    path?: never
    query?: never
    url: "/torrents/info"