Tsarr Documentation - v1.8.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();
    Index

    Constructors

    constructor

    Methods

    getSystemStatus getHealth getAuthors getAuthor addAuthor updateAuthor deleteAuthor getBooks getBook searchAuthors runCommand getCommands getRootFolders addRootFolder getHostConfig getHostConfigById updateHostConfig getNamingConfig getNamingConfigById updateNamingConfig getNamingConfigExamples getMediaManagementConfig getMediaManagementConfigById updateMediaManagementConfig getUiConfig getUiConfigById updateUiConfig getDevelopmentConfig getDevelopmentConfigById updateDevelopmentConfig getMetadataProviderConfig getMetadataProviderConfigById updateMetadataProviderConfig restartSystem shutdownSystem getSystemBackups deleteSystemBackup restoreSystemBackup uploadSystemBackup getSystemLogs getLogFiles getLogFileByName getDiskSpace getTags addTag getTag updateTag deleteTag getTagDetails getTagDetailById addBook updateBook deleteBook searchBooks getQualityProfiles getQualityProfile addQualityProfile updateQualityProfile deleteQualityProfile getQualityProfileSchema getCustomFormats getCustomFormat addCustomFormat updateCustomFormat deleteCustomFormat getCustomFormatSchema getDownloadClients getDownloadClient addDownloadClient updateDownloadClient deleteDownloadClient getDownloadClientSchema testDownloadClient testAllDownloadClients getIndexers getIndexer addIndexer updateIndexer deleteIndexer getIndexerSchema testIndexer testAllIndexers getImportLists getImportList addImportList updateImportList deleteImportList getImportListSchema testImportList testAllImportLists getNotifications getNotification addNotification updateNotification deleteNotification getNotificationSchema testNotification testAllNotifications updateConfig

    Constructors

    Methods

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

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

    • 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.CommandResource[]; 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 },
      >

    • Get host configuration settings

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

    • Get host configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.HostConfigResource; 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 UI configuration settings

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

    • Get UI configuration by ID

      Parameters

      • id: number

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

    • Update UI configuration

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.UiConfigResource; 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 },
      >

    • Restart the Readarr application

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

    • Shutdown the Readarr application

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

    • Get system backup files

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

    • Delete a system backup by ID

      Parameters

      • id: number

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

    • Restore system backup by ID

      Parameters

      • id: number

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

    • Upload and restore system backup

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; 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 log files

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

    • Get specific log file by filename

      Parameters

      • filename: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; 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 },
      >

    • Get all tags

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

    • Add a new tag

      Parameters

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

    • Get a specific tag by ID

      Parameters

      • id: number

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

    • Update an existing tag

      Parameters

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

    • Delete a tag

      Parameters

      • id: number

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

    • Get detailed tag information

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

    • Get detailed tag information by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Readarr.TagDetailsResource; 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 },
      >

    • 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 download clients

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

    • Get a specific download client by ID

      Parameters

      • id: number

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

    • Delete a download client

      Parameters

      • id: number

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

    • Get download client schema for available client types

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

    • Test a download client configuration

      Parameters

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

    • Test all download clients

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

    • Get all indexers

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

    • Get a specific indexer by ID

      Parameters

      • id: number

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

    • Update an existing indexer

      Parameters

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

    • Delete an indexer

      Parameters

      • id: number

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

    • Get indexer schema for available indexer types

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

    • Test an indexer configuration

      Parameters

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

    • Test all indexers

      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 },
      >

    • 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 all notification providers

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

    • Get a specific notification provider by ID

      Parameters

      • id: number

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

    • Delete a notification provider

      Parameters

      • id: number

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

    • Get notification schema for available notification types

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

    • Test a notification configuration

      Parameters

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

    • Test all notifications

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

    • Parameters

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    getSystemStatusgetHealthgetAuthorsgetAuthoraddAuthorupdateAuthordeleteAuthorgetBooksgetBooksearchAuthorsrunCommandgetCommandsgetRootFoldersaddRootFoldergetHostConfiggetHostConfigByIdupdateHostConfiggetNamingConfiggetNamingConfigByIdupdateNamingConfiggetNamingConfigExamplesgetMediaManagementConfiggetMediaManagementConfigByIdupdateMediaManagementConfiggetUiConfiggetUiConfigByIdupdateUiConfiggetDevelopmentConfiggetDevelopmentConfigByIdupdateDevelopmentConfiggetMetadataProviderConfiggetMetadataProviderConfigByIdupdateMetadataProviderConfigrestartSystemshutdownSystemgetSystemBackupsdeleteSystemBackuprestoreSystemBackupuploadSystemBackupgetSystemLogsgetLogFilesgetLogFileByNamegetDiskSpacegetTagsaddTaggetTagupdateTagdeleteTaggetTagDetailsgetTagDetailByIdaddBookupdateBookdeleteBooksearchBooksgetQualityProfilesgetQualityProfileaddQualityProfileupdateQualityProfiledeleteQualityProfilegetQualityProfileSchemagetCustomFormatsgetCustomFormataddCustomFormatupdateCustomFormatdeleteCustomFormatgetCustomFormatSchemagetDownloadClientsgetDownloadClientaddDownloadClientupdateDownloadClientdeleteDownloadClientgetDownloadClientSchematestDownloadClienttestAllDownloadClientsgetIndexersgetIndexeraddIndexerupdateIndexerdeleteIndexergetIndexerSchematestIndexertestAllIndexersgetImportListsgetImportListaddImportListupdateImportListdeleteImportListgetImportListSchematestImportListtestAllImportListsgetNotificationsgetNotificationaddNotificationupdateNotificationdeleteNotificationgetNotificationSchematestNotificationtestAllNotificationsupdateConfig