Class QBittorrent

constructor

• new QBittorrent(options?: Partial<TorrentClientConfig>): QBittorrent

  Parameters

  • options: Partial<TorrentClientConfig> = {}

  Returns QBittorrent

config

state

addMagnet

• addMagnet(urls: string, options?: Partial<AddMagnetOptions>): Promise<boolean>

  Parameters

  • urls: string

    URLs separated with newlines
  • options: Partial<AddMagnetOptions> = {}

  Returns Promise<boolean>

addTorrent

• addTorrent(
      torrent: string | Uint8Array<ArrayBufferLike>,
      options?: Partial<AddTorrentOptions>,
  ): Promise<boolean>

  Parameters

  • torrent: string | Uint8Array<ArrayBufferLike>
  • options: Partial<AddTorrentOptions> = {}

  Returns Promise<boolean>

addTorrentTags

• addTorrentTags(hashes: string | string[], tags: string): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#add-torrent-tags

  Parameters

  • hashes: string | string[]
  • tags: string

  Returns Promise<boolean>

addTrackers

• addTrackers(hash: string, urls: string): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#add-trackers-to-torrent

  Parameters

  • hash: string
  • urls: string

  Returns Promise<boolean>

bottomPriority

• bottomPriority(hashes: string | string[]): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#minimal-torrent-priority

  Parameters

  • hashes: string | string[]

  Returns Promise<boolean>

createCategory

• createCategory(category: string, savePath?: string): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#add-new-category

  Parameters

  • category: string
  • savePath: string = ''

  Returns Promise<boolean>

createTags

• createTags(tags: string): Promise<boolean>

  Parameters

  • tags: string

    comma separated list https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#create-tags

  Returns Promise<boolean>

deleteTags

• deleteTags(tags: string): Promise<boolean>

  Parameters

  • tags: string

    comma separated list https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#delete-tags

  Returns Promise<boolean>

editCategory

• editCategory(category: string, savePath?: string): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#edit-category

  Parameters

  • category: string
  • savePath: string = ''

  Returns Promise<boolean>

editTrackers

• editTrackers(hash: string, origUrl: string, newUrl: string): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#edit-trackers

  Parameters

  • hash: string
  • origUrl: string
  • newUrl: string

  Returns Promise<boolean>

exportState

• exportState(): JsonifyObject<
      {
          auth?: { expires: Date; sid: string };
          version?: { isVersion5OrHigher: boolean; version: string };
      },
  >

  Export the state of the client as JSON

  Returns JsonifyObject<
      {
          auth?: { expires: Date; sid: string };
          version?: { isVersion5OrHigher: boolean; version: string };
      },
  >

getAllData

• getAllData(): Promise<AllClientData>

  Returns all torrent data. Data has been normalized

  Returns Promise<AllClientData>

getApiVersion

• getApiVersion(): Promise<string>

  Returns Promise<string>

getAppVersion

• getAppVersion(): Promise<string>

  Get application version https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-version

  Returns Promise<string>

getBuildInfo

• getBuildInfo(): Promise<BuildInfo>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-build-info

  Returns Promise<BuildInfo>

getCategories

• getCategories(): Promise<TorrentCategories>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-all-categories

  Returns Promise<TorrentCategories>

getDefaultSavePath

• getDefaultSavePath(): Promise<string>

  Get default save path

  Returns Promise<string>

getPreferences

• getPreferences(): Promise<Preferences>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-preferences

  Returns Promise<Preferences>

getTags

• getTags(): Promise<string[]>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-all-tags

  Returns Promise<string[]>

getTorrent

• getTorrent(hash: string): Promise<NormalizedTorrent>

  Parameters

  • hash: string

  Returns Promise<NormalizedTorrent>

getTorrentDownloadLimit

• getTorrentDownloadLimit(hash: string | string[]): Promise<DownloadSpeed>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-download-limit

  Parameters

  • hash: string | string[]

  Returns Promise<DownloadSpeed>

getTorrentUploadLimit

• getTorrentUploadLimit(hash: string | string[]): Promise<UploadSpeed>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-upload-limit

  Parameters

  • hash: string | string[]

  Returns Promise<UploadSpeed>

listTorrents

• listTorrents(
      __namedParameters?: {
          category?: string;
          filter?: TorrentFilters;
          hashes?: string | string[];
          offset?: number;
          reverse?: boolean;
          sort?: string;
          tag?: string;
      },
  ): Promise<Torrent[]>

  Torrents list

  Parameters

  • __namedParameters: {
        category?: string;
        filter?: TorrentFilters;
        hashes?: string | string[];
        offset?: number;
        reverse?: boolean;
        sort?: string;
        tag?: string;
    } = {}

  Returns Promise<Torrent[]>

  list of torrents

login

• login(): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#login

  Returns Promise<boolean>

logout

• logout(): boolean

  Returns boolean

normalizedAddTorrent

• normalizedAddTorrent(
      torrent: string | Uint8Array<ArrayBufferLike>,
      options?: Partial<AddTorrentOptions>,
  ): Promise<NormalizedTorrent>

  Parameters

  • torrent: string | Uint8Array<ArrayBufferLike>
  • options: Partial<AddTorrentOptions> = {}

  Returns Promise<NormalizedTorrent>

pauseTorrent

• pauseTorrent(hashes: string | string[]): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#pause-torrents

  Parameters

  • hashes: string | string[]

  Returns Promise<boolean>

queueDown

• queueDown(hashes: string | string[]): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#decrease-torrent-priority

  Parameters

  • hashes: string | string[]

  Returns Promise<boolean>

queueUp

• queueUp(hashes: string | string[]): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#increase-torrent-priority

  Parameters

  • hashes: string | string[]

  Returns Promise<boolean>

reannounceTorrent

• reannounceTorrent(hashes: string | string[]): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#reannounce-torrents

  Parameters

  • hashes: string | string[]

  Returns Promise<boolean>

recheckTorrent

• recheckTorrent(hashes: string | string[]): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#recheck-torrents

  Parameters

  • hashes: string | string[]

  Returns Promise<boolean>

removeCategory

• removeCategory(categories: string): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#remove-categories

  Parameters

  • categories: string

  Returns Promise<boolean>

removeTorrent

• removeTorrent(
      hashes: string | string[],
      deleteFiles?: boolean,
  ): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#delete-torrents

  Parameters

  • hashes: string | string[]
  • deleteFiles: boolean = false

    (default: false) remove files from disk

  Returns Promise<boolean>

removeTorrentTags

• removeTorrentTags(hashes: string | string[], tags?: string): Promise<boolean>

  if tags are not passed, removes all tags https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#remove-torrent-tags

  Parameters

  • hashes: string | string[]
  • Optionaltags: string

  Returns Promise<boolean>

removeTrackers

• removeTrackers(hash: string, urls: string): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#remove-trackers

  Parameters

  • hash: string
  • urls: string

  Returns Promise<boolean>

renameFile

• renameFile(hash: string, oldPath: string, newPath: string): Promise<boolean>

  Parameters

  • hash: string

    Hash for desired torrent
  • oldPath: string

    id of the file to be renamed
  • newPath: string

    new name to be assigned to the file

  Returns Promise<boolean>

renameFolder

• renameFolder(hash: string, oldPath: string, newPath: string): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#rename-folder

  Parameters

  • hash: string
  • oldPath: string
  • newPath: string

  Returns Promise<boolean>

request

• request<T>(
      path: string,
      method: "GET" | "POST",
      params?: Record<string, string | number>,
      body?: URLSearchParams | FormData,
      headers?: Record<string, string>,
      isJson?: boolean,
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • path: string
  • method: "GET" | "POST"
  • Optionalparams: Record<string, string | number>
  • Optionalbody: URLSearchParams | FormData
  • headers: Record<string, string> = {}
  • isJson: boolean = true

  Returns Promise<T>

resetTorrentCategory

• resetTorrentCategory(hashes: string | string[]): Promise<boolean>

  helper function to remove torrent category

  Parameters

  • hashes: string | string[]

  Returns Promise<boolean>

resumeTorrent

• resumeTorrent(hashes: string | string[]): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#resume-torrents

  Parameters

  • hashes: string | string[]

  Returns Promise<boolean>

setFilePriority

• setFilePriority(
      hash: string,
      fileIds: string | string[],
      priority: TorrentFilePriority,
  ): Promise<boolean>

  Parameters

  • hash: string
  • fileIds: string | string[]
  • priority: TorrentFilePriority

  Returns Promise<boolean>

setPreferences

• setPreferences(preferences: Partial<Preferences>): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-application-preferences

  Parameters

  • preferences: Partial<Preferences>

  Returns Promise<boolean>

setTorrentCategory

• setTorrentCategory(
      hashes: string | string[],
      category?: string,
  ): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-category

  Parameters

  • hashes: string | string[]
  • category: string = ''

  Returns Promise<boolean>

setTorrentDownloadLimit

• setTorrentDownloadLimit(
      hash: string | string[],
      limitBytesPerSecond: number,
  ): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-download-limit

  Parameters

  • hash: string | string[]
  • limitBytesPerSecond: number

  Returns Promise<boolean>

setTorrentLocation

• setTorrentLocation(
      hashes: string | string[],
      location: string,
  ): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-location

  Parameters

  • hashes: string | string[]
  • location: string

  Returns Promise<boolean>

setTorrentName

• setTorrentName(hash: string, name: string): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-name

  Parameters

  • hash: string
  • name: string

  Returns Promise<boolean>

setTorrentUploadLimit

• setTorrentUploadLimit(
      hash: string | string[],
      limitBytesPerSecond: number,
  ): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-torrent-upload-limit

  Parameters

  • hash: string | string[]
  • limitBytesPerSecond: number

  Returns Promise<boolean>

topPriority

• topPriority(hashes: string | string[]): Promise<boolean>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#maximal-torrent-priority

  Parameters

  • hashes: string | string[]

  Returns Promise<boolean>

torrentFiles

• torrentFiles(hash: string): Promise<TorrentFile[]>

  Parameters

  • hash: string

  Returns Promise<TorrentFile[]>

torrentPeers

• torrentPeers(hash: string, rid?: number): Promise<TorrentPeersResponse>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-peers-data

  Parameters

  • hash: string
  • Optionalrid: number

    Response ID. If not provided, rid=0 will be assumed. If the given rid is different from the one of last server reply, full_update will be true (see the server reply details for more info)

  Returns Promise<TorrentPeersResponse>

torrentPieceHashes

• torrentPieceHashes(hash: string): Promise<string[]>

  Torrents piece hashes

  Parameters

  • hash: string

  Returns Promise<string[]>

  an array of hashes (strings) of all pieces (in order) of a specific torrent https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-pieces-hashes

torrentPieceStates

• torrentPieceStates(hash: string): Promise<TorrentPieceState[]>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-pieces-states

  Parameters

  • hash: string

  Returns Promise<TorrentPieceState[]>

torrentProperties

• torrentProperties(hash: string): Promise<TorrentProperties>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-generic-properties

  Parameters

  • hash: string

  Returns Promise<TorrentProperties>

torrentTrackers

• torrentTrackers(hash: string): Promise<TorrentTrackers[]>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-trackers

  Parameters

  • hash: string

  Returns Promise<TorrentTrackers[]>

torrentWebSeeds

• torrentWebSeeds(hash: string): Promise<WebSeed[]>

  https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-web-seeds

  Parameters

  • hash: string

  Returns Promise<WebSeed[]>

version

• version(): Promise<string>

  Returns Promise<string>

  Deprecated

StaticcreateFromState

• createFromState(
      config: Readonly<TorrentClientConfig>,
      state: Readonly<
          JsonifyObject<
              {
                  auth?: { expires: Date; sid: string };
                  version?: { isVersion5OrHigher: boolean; version: string };
              },
          >,
      >,
  ): QBittorrent

  Create a new QBittorrent client from a state

  Parameters

  • config: Readonly<TorrentClientConfig>
  • state: Readonly<
        JsonifyObject<
            {
                auth?: { expires: Date; sid: string };
                version?: { isVersion5OrHigher: boolean; version: string };
            },
        >,
    >

  Returns QBittorrent