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

    Class ReadarrClient

    Readarr API client for book management

    const readarr = new ReadarrClient({
      baseUrl: 'http://localhost:8787',
      apiKey: 'your-api-key'
    });

    const authors = await readarr.getAuthors();

    Hierarchy

    • ServarrBaseClient
      • ReadarrClient
    Index

    Constructors

    constructor

    Methods

    getSystemStatus getHealth getTags addTag getTag updateTag deleteTag getTagDetails getTagDetailById getNotifications getNotification addNotification updateNotification deleteNotification getNotificationSchema testNotification testAllNotifications getDownloadClients getDownloadClient addDownloadClient updateDownloadClient deleteDownloadClient getDownloadClientSchema testDownloadClient testAllDownloadClients getIndexers getIndexer addIndexer updateIndexer deleteIndexer getIndexerSchema testIndexer testAllIndexers restartSystem shutdownSystem getSystemBackups deleteSystemBackup restoreSystemBackup uploadSystemBackup getLogFiles getLogFileByName runCommand getCommands getHostConfig getHostConfigById updateHostConfig getUiConfig getUiConfigById updateUiConfig updateConfig getAuthors getAuthor addAuthor updateAuthor deleteAuthor getBooks getBook searchAuthors getRootFolders addRootFolder deleteRootFolder getNamingConfig getNamingConfigById updateNamingConfig getNamingConfigExamples getMediaManagementConfig getMediaManagementConfigById updateMediaManagementConfig getDevelopmentConfig getDevelopmentConfigById updateDevelopmentConfig getMetadataProviderConfig getMetadataProviderConfigById updateMetadataProviderConfig getSystemLogs getDiskSpace addBook updateBook deleteBook searchBooks getCalendar getCalendarFeed getBookFiles getBookFile updateBookFile deleteBookFile updateBookFilesEditor deleteBookFilesBulk getQualityProfiles getQualityProfile addQualityProfile updateQualityProfile deleteQualityProfile getQualityProfileSchema getCustomFormats getCustomFormat addCustomFormat updateCustomFormat deleteCustomFormat getCustomFormatSchema getImportLists getImportList addImportList updateImportList deleteImportList getImportListSchema testImportList testAllImportLists getHistory getHistorySince getAuthorHistory markHistoryItemFailed getQueue removeQueueItem removeQueueItemsBulk grabQueueItem grabQueueItemsBulk getQueueDetails getQueueStatus getBlocklist removeBlocklistItem removeBlocklistItemsBulk getWantedMissing getWantedCutoff

    Constructors

    Methods

    • Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • tag: { id?: number; label?: string | null }

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • id: string | number
      • tag: { id?: number; label?: string | null }

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • notification: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: string | number
      • notification: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • notification: Record<string, unknown>

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • client: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: string | number
      • client: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • client: Record<string, unknown>

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • indexer: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: string | number
      • indexer: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • indexer: Record<string, unknown>

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • filename: string

      Returns Promise<any>

    • Parameters

      • command: Record<string, unknown>

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • id: string | number
      • config: Record<string, unknown>

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • id: string | number
      • config: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      Returns {
          baseUrl: string;
          apiKey: string;
          timeout?: number;
          retry?: RetryOptions;
          headers?: Record<string, string>;
      }

      • baseUrl: string
      • apiKey: string
      • Optionaltimeout?: number

        Request timeout in milliseconds (default: 30000)

      • Optionalretry?: RetryOptions

        Retry configuration for transient failures

      • Optionalheaders?: Record<string, string>

    • Get all authors in the library

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: AuthorResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: AuthorResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: AuthorResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: AuthorResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: BookResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: BookResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Search for authors using Goodreads database

      Parameters

      • term: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.RootFolderResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • path: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.RootFolderResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get naming configuration settings

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.NamingConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get naming configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.NamingConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get naming configuration examples

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get media management configuration settings

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.MediaManagementConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get media management configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.MediaManagementConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get development configuration settings

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.DevelopmentConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get development configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.DevelopmentConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get metadata provider configuration settings

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.MetadataProviderConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get metadata provider configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.MetadataProviderConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get system logs

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.LogResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get disk space information

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.DiskSpaceResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Add a new book

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: BookResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Update an existing book

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: BookResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Delete a book

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Search for books

      Parameters

      • term: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • Optionalstart: string
      • Optionalend: string
      • Optionalunmonitored: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: BookResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • OptionalpastDays: number
      • OptionalfutureDays: number
      • OptionaltagList: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get book files by author, book, or specific file IDs

      Parameters

      • OptionalauthorId: number
      • OptionalbookFileIds: number[]
      • OptionalbookId: number[]
      • Optionalunmapped: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: BookFileResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get a specific book file by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: BookFileResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Update a book file

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: BookFileResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Delete a book file from disk

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk update book files using the editor endpoint

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk delete book files

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get all quality profiles

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.QualityProfileResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get a specific quality profile by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.QualityProfileResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Delete a quality profile

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get quality profile schema

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.QualityProfileResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get all custom formats

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.CustomFormatResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get a specific custom format by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.CustomFormatResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Delete a custom format

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get custom format schema

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get all import lists

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.ImportListResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get a specific import list by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.ImportListResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Update an existing import list

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.ImportListResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Delete an import list

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get import list schema for available list types

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.ImportListResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Test an import list configuration

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Test all import lists

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get activity history

      Parameters

      • Optionalpage: number
      • OptionalpageSize: number
      • OptionalsortKey: string
      • OptionalsortDirection: string
      • OptionalauthorId: number
      • OptionaldownloadId: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.HistoryResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get history since a specific date

      Parameters

      • date: string
      • OptionalauthorId: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.HistoryResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get history for a specific author

      Parameters

      • authorId: number
      • OptionalbookId: number
      • OptionaleventType: any

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.HistoryResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Mark a failed download as failed in history

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get download queue

      Parameters

      • Optionalpage: number
      • OptionalpageSize: number
      • OptionalsortKey: string
      • OptionalsortDirection: string
      • OptionalincludeUnknownAuthorItems: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.QueueResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Remove an item from the download queue

      Parameters

      • id: number
      • OptionalremoveFromClient: boolean
      • Optionalblocklist: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk remove items from the download queue

      Parameters

      • ids: number[]
      • OptionalremoveFromClient: boolean
      • Optionalblocklist: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Force grab a queue item

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Force grab multiple queue items

      Parameters

      • ids: number[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get detailed queue information

      Parameters

      • OptionalauthorId: number
      • OptionalincludeUnknownAuthorItems: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.QueueResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get queue status summary

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.QueueStatusResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get blocked releases

      Parameters

      • Optionalpage: number
      • OptionalpageSize: number
      • OptionalsortKey: string
      • OptionalsortDirection: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.BlocklistResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Remove a release from the blocklist

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk remove releases from the blocklist

      Parameters

      • ids: number[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get books with missing files

      Parameters

      • Optionalpage: number
      • OptionalpageSize: number
      • OptionalsortKey: string
      • OptionalsortDirection: string
      • Optionalmonitored: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: BookResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get books below cutoff quality

      Parameters

      • Optionalpage: number
      • OptionalpageSize: number
      • OptionalsortKey: string
      • OptionalsortDirection: string
      • Optionalmonitored: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: BookResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    getSystemStatusgetHealthgetTagsaddTaggetTagupdateTagdeleteTaggetTagDetailsgetTagDetailByIdgetNotificationsgetNotificationaddNotificationupdateNotificationdeleteNotificationgetNotificationSchematestNotificationtestAllNotificationsgetDownloadClientsgetDownloadClientaddDownloadClientupdateDownloadClientdeleteDownloadClientgetDownloadClientSchematestDownloadClienttestAllDownloadClientsgetIndexersgetIndexeraddIndexerupdateIndexerdeleteIndexergetIndexerSchematestIndexertestAllIndexersrestartSystemshutdownSystemgetSystemBackupsdeleteSystemBackuprestoreSystemBackupuploadSystemBackupgetLogFilesgetLogFileByNamerunCommandgetCommandsgetHostConfiggetHostConfigByIdupdateHostConfiggetUiConfiggetUiConfigByIdupdateUiConfigupdateConfiggetAuthorsgetAuthoraddAuthorupdateAuthordeleteAuthorgetBooksgetBooksearchAuthorsgetRootFoldersaddRootFolderdeleteRootFoldergetNamingConfiggetNamingConfigByIdupdateNamingConfiggetNamingConfigExamplesgetMediaManagementConfiggetMediaManagementConfigByIdupdateMediaManagementConfiggetDevelopmentConfiggetDevelopmentConfigByIdupdateDevelopmentConfiggetMetadataProviderConfiggetMetadataProviderConfigByIdupdateMetadataProviderConfiggetSystemLogsgetDiskSpaceaddBookupdateBookdeleteBooksearchBooksgetCalendargetCalendarFeedgetBookFilesgetBookFileupdateBookFiledeleteBookFileupdateBookFilesEditordeleteBookFilesBulkgetQualityProfilesgetQualityProfileaddQualityProfileupdateQualityProfiledeleteQualityProfilegetQualityProfileSchemagetCustomFormatsgetCustomFormataddCustomFormatupdateCustomFormatdeleteCustomFormatgetCustomFormatSchemagetImportListsgetImportListaddImportListupdateImportListdeleteImportListgetImportListSchematestImportListtestAllImportListsgetHistorygetHistorySincegetAuthorHistorymarkHistoryItemFailedgetQueueremoveQueueItemremoveQueueItemsBulkgrabQueueItemgrabQueueItemsBulkgetQueueDetailsgetQueueStatusgetBlocklistremoveBlocklistItemremoveBlocklistItemsBulkgetWantedMissinggetWantedCutoff