Class BazarrClient

Bazarr API client for subtitle management

Example

const bazarr = new BazarrClient({
  baseUrl: 'http://localhost:6767',
  apiKey: 'your-api-key'
});

const wantedMovies = await bazarr.getMoviesWanted();
const providers = await bazarr.getProviders();

Index

Constructors

constructor

Methods

getSystemStatus getSystemHealth ping getSystemReleases getSystemAnnouncements dismissAnnouncement getSystemLogs rotateLogs getSystemTasks runSystemTask getBackups createBackup restoreBackup deleteBackup getJobs manageJob deleteJob emptyJobQueue getLanguages getLanguageProfiles getSeries updateSeriesLanguageProfile runSeriesAction getEpisodes getEpisodesWanted getEpisodesHistory downloadEpisodeSubtitles uploadEpisodeSubtitles deleteEpisodeSubtitles getEpisodesBlacklist addEpisodeToBlacklist removeEpisodeFromBlacklist getMovies updateMoviesLanguageProfile runMovieAction getMoviesWanted getMoviesHistory downloadMovieSubtitles uploadMovieSubtitles deleteMovieSubtitles getMoviesBlacklist addMovieToBlacklist removeMovieFromBlacklist getProviders resetProviders searchEpisodeSubtitles downloadProviderEpisodeSubtitles searchMovieSubtitles downloadProviderMovieSubtitles getSubtitles applySubtitleMods getSubtitleNameInfo getHistoryStats getBadges search browseBazarrFs browseRadarrFs browseSonarrFs testWebhook triggerPlexWebhook triggerRadarrWebhook triggerSonarrWebhook updateConfig

Constructors

constructor

new BazarrClient(config: ServarrClientConfig): BazarrClient
Parameters
- config: ServarrClientConfig
Returns BazarrClient
- Defined in clients/bazarr.ts:23

Methods

getSystemStatus

getSystemStatus(): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Get Bazarr system status and version information

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:37

getSystemHealth

getSystemHealth(): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Get system health check results

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:44

ping

ping(): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: unknown; error: undefined }
    ) & { request: Request; response: Response },
>
Ping the Bazarr instance

Returns Promise<
    (
        | { data: undefined; error: unknown }
        | { data: unknown; error: undefined }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:51

getSystemReleases

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

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:58

getSystemAnnouncements

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

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:65

dismissAnnouncement

dismissAnnouncement(
    hash: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Dismiss an announcement by hash
Parameters
- hash: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:72

getSystemLogs

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

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:79

rotateLogs

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

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:86

getSystemTasks

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

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:93

runSystemTask

runSystemTask(
    taskId: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Run a system task
Parameters
- taskId: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:100

getBackups

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

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:109

createBackup

createBackup(): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Create a new backup

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:116

restoreBackup

restoreBackup(
    filename: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Restore a backup
Parameters
- filename: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:123

deleteBackup

deleteBackup(
    filename: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Delete a backup file
Parameters
- filename: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:130

getJobs

getJobs(
    id?: number,
    status?: "pending" | "running" | "failed" | "completed",
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
List jobs in the queue
Parameters
- Optionalid: number
- Optionalstatus: "pending" | "running" | "failed" | "completed"
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:139

manageJob

manageJob(
    id: number,
    action: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Force start, move to top, or move to bottom a job
Parameters
- id: number
- action: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:150

deleteJob

deleteJob(
    id: number,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Delete a job from the queue
Parameters
- id: number
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:157

emptyJobQueue

emptyJobQueue(
    queueName: "pending" | "failed" | "completed",
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Empty a specific jobs queue
Parameters
- queueName: "pending" | "failed" | "completed"
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:164

getLanguages

getLanguages(
    history?: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
List available languages
Parameters
- Optionalhistory: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:173

getLanguageProfiles

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

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:180

getSeries

getSeries(
    seriesIds?: number[],
    start?: number,
    length?: number,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
List series metadata
Parameters
- OptionalseriesIds: number[]
- Optionalstart: number
- Optionallength: number
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:189

updateSeriesLanguageProfile

updateSeriesLanguageProfile(
    seriesId?: number[],
    profileId?: string[],
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Update series language profile
Parameters
- OptionalseriesId: number[]
- OptionalprofileId: string[]
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:201

runSeriesAction

runSeriesAction(
    seriesId?: number,
    action?: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Run actions on specific series (scan-disk, search-missing, search-wanted, sync)
Parameters
- OptionalseriesId: number
- Optionalaction: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:212

getEpisodes

getEpisodes(
    seriesIds?: number[],
    episodeIds?: number[],
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
List episodes metadata
Parameters
- OptionalseriesIds: number[]
- OptionalepisodeIds: number[]
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:225

getEpisodesWanted

getEpisodesWanted(
    start?: number,
    length?: number,
    episodeIds?: number[],
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Get episodes with wanted subtitles
Parameters
- Optionalstart: number
- Optionallength: number
- OptionalepisodeIds: number[]
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:236

getEpisodesHistory

getEpisodesHistory(
    start?: number,
    length?: number,
    episodeId?: number,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Get episode history events
Parameters
- Optionalstart: number
- Optionallength: number
- OptionalepisodeId: number
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:248

downloadEpisodeSubtitles

downloadEpisodeSubtitles(
    seriesId: number,
    episodeId: number,
    language: string,
    forced: string,
    hi: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Download episode subtitles
Parameters
- seriesId: number
- episodeId: number
- language: string
- forced: string
- hi: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:260

uploadEpisodeSubtitles

uploadEpisodeSubtitles(
    seriesId: number,
    episodeId: number,
    language: string,
    forced: string,
    hi: string,
    file: Blob | File,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Upload episode subtitles
Parameters
- seriesId: number
- episodeId: number
- language: string
- forced: string
- hi: string
- file: Blob | File
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:275

deleteEpisodeSubtitles

deleteEpisodeSubtitles(
    seriesId: number,
    episodeId: number,
    language: string,
    forced: string,
    hi: string,
    path: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Delete episode subtitles
Parameters
- seriesId: number
- episodeId: number
- language: string
- forced: string
- hi: string
- path: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:292

getEpisodesBlacklist

getEpisodesBlacklist(
    start?: number,
    length?: number,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
List blacklisted episode subtitles
Parameters
- Optionalstart: number
- Optionallength: number
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:310

addEpisodeToBlacklist

addEpisodeToBlacklist(
    seriesId: number,
    episodeId: number,
    provider: string,
    subsId: string,
    language: string,
    subtitlesPath: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Add episode subtitles to blacklist
Parameters
- seriesId: number
- episodeId: number
- provider: string
- subsId: string
- language: string
- subtitlesPath: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:321

removeEpisodeFromBlacklist

removeEpisodeFromBlacklist(
    all?: string,
    provider?: string,
    subsId?: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Remove episode subtitles from blacklist
Parameters
- Optionalall: string
- Optionalprovider: string
- OptionalsubsId: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:344

getMovies

getMovies(
    radarrIds?: number[],
    start?: number,
    length?: number,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
List movies metadata
Parameters
- OptionalradarrIds: number[]
- Optionalstart: number
- Optionallength: number
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:358

updateMoviesLanguageProfile

updateMoviesLanguageProfile(
    radarrId?: number[],
    profileId?: string[],
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Update movies language profile
Parameters
- OptionalradarrId: number[]
- OptionalprofileId: string[]
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:370

runMovieAction

runMovieAction(
    radarrId?: number,
    action?: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Run actions on specific movies (scan-disk, search-missing, search-wanted, sync)
Parameters
- OptionalradarrId: number
- Optionalaction: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:381

getMoviesWanted

getMoviesWanted(
    start?: number,
    length?: number,
    radarrIds?: number[],
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Get movies with wanted subtitles
Parameters
- Optionalstart: number
- Optionallength: number
- OptionalradarrIds: number[]
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:392

getMoviesHistory

getMoviesHistory(
    start?: number,
    length?: number,
    radarrId?: number,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Get movie history events
Parameters
- Optionalstart: number
- Optionallength: number
- OptionalradarrId: number
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:404

downloadMovieSubtitles

downloadMovieSubtitles(
    radarrId: number,
    language: string,
    forced: string,
    hi: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Download movie subtitles
Parameters
- radarrId: number
- language: string
- forced: string
- hi: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:416

uploadMovieSubtitles

uploadMovieSubtitles(
    radarrId: number,
    language: string,
    forced: string,
    hi: string,
    file: Blob | File,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Upload movie subtitles
Parameters
- radarrId: number
- language: string
- forced: string
- hi: string
- file: Blob | File
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:425

deleteMovieSubtitles

deleteMovieSubtitles(
    radarrId: number,
    language: string,
    forced: string,
    hi: string,
    path: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Delete movie subtitles
Parameters
- radarrId: number
- language: string
- forced: string
- hi: string
- path: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:441

getMoviesBlacklist

getMoviesBlacklist(
    start?: number,
    length?: number,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
List blacklisted movie subtitles
Parameters
- Optionalstart: number
- Optionallength: number
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:458

addMovieToBlacklist

addMovieToBlacklist(
    radarrId: number,
    provider: string,
    subsId: string,
    language: string,
    subtitlesPath: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Add movie subtitles to blacklist
Parameters
- radarrId: number
- provider: string
- subsId: string
- language: string
- subtitlesPath: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:469

removeMovieFromBlacklist

removeMovieFromBlacklist(
    all?: string,
    provider?: string,
    subsId?: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Remove movie subtitles from blacklist
Parameters
- Optionalall: string
- Optionalprovider: string
- OptionalsubsId: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:490

getProviders

getProviders(): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Get subtitle providers status

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:504

resetProviders

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

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:511

searchEpisodeSubtitles

searchEpisodeSubtitles(
    episodeId: number,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Search for episode subtitles from providers
Parameters
- episodeId: number
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:518

downloadProviderEpisodeSubtitles

downloadProviderEpisodeSubtitles(
    seriesId: number,
    episodeId: number,
    hi: string,
    forced: string,
    originalFormat: string,
    provider: string,
    subtitle: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Download episode subtitles from provider
Parameters
- seriesId: number
- episodeId: number
- hi: string
- forced: string
- originalFormat: string
- provider: string
- subtitle: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:525

searchMovieSubtitles

searchMovieSubtitles(
    radarrId: number,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Search for movie subtitles from providers
Parameters
- radarrId: number
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:550

downloadProviderMovieSubtitles

downloadProviderMovieSubtitles(
    radarrId: number,
    hi: string,
    forced: string,
    originalFormat: string,
    provider: string,
    subtitle: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Download movie subtitles from provider
Parameters
- radarrId: number
- hi: string
- forced: string
- originalFormat: string
- provider: string
- subtitle: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:557

getSubtitles

getSubtitles(
    data: Bazarr.Options<GetSubtitlesData, boolean>,
): Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
Get subtitles tracks for a media file
Parameters
- data: Bazarr.Options<GetSubtitlesData, boolean>
Returns Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
- Defined in clients/bazarr.ts:582

applySubtitleMods

applySubtitleMods(
    data: Bazarr.Options<PatchSubtitlesData, boolean>,
): Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
Apply mods/tools on external subtitles
Parameters
- data: Bazarr.Options<PatchSubtitlesData, boolean>
Returns Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
- Defined in clients/bazarr.ts:589

getSubtitleNameInfo

getSubtitleNameInfo(
    data: Bazarr.Options<GetSubtitleNameInfoData, boolean>,
): Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
Get subtitle name info via guessit
Parameters
- data: Bazarr.Options<GetSubtitleNameInfoData, boolean>
Returns Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
- Defined in clients/bazarr.ts:596

getHistoryStats

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

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:605

getBadges

getBadges(): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Get UI badge counts

Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:614

search

search(
    data: Bazarr.Options<GetSearchesData, boolean>,
): Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
Search across the system
Parameters
- data: Bazarr.Options<GetSearchesData, boolean>
Returns Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
- Defined in clients/bazarr.ts:623

browseBazarrFs

browseBazarrFs(
    path?: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Browse Bazarr file system
Parameters
- Optionalpath: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:632

browseRadarrFs

browseRadarrFs(
    path?: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Browse Radarr file system
Parameters
- Optionalpath: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:639

browseSonarrFs

browseSonarrFs(
    path?: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Browse Sonarr file system
Parameters
- Optionalpath: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:646

testWebhook

testWebhook(): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: unknown; error: undefined }
    ) & { request: Request; response: Response },
>
Test external webhook connection

Returns Promise<
    (
        | { data: undefined; error: unknown }
        | { data: unknown; error: undefined }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:655

triggerPlexWebhook

triggerPlexWebhook(
    payload: string,
): Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
Trigger Plex webhook
Parameters
- payload: string
Returns Promise<
    (
        | { data: unknown; error: undefined }
        | { data: undefined; error: unknown }
    ) & { request: Request; response: Response },
>
- Defined in clients/bazarr.ts:662

triggerRadarrWebhook

triggerRadarrWebhook(
    data: Bazarr.Options<PostWebHooksRadarrData, boolean>,
): Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
Trigger Radarr webhook
Parameters
- data: Bazarr.Options<PostWebHooksRadarrData, boolean>
Returns Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
- Defined in clients/bazarr.ts:669

triggerSonarrWebhook

triggerSonarrWebhook(
    data: Bazarr.Options<PostWebHooksSonarrData, boolean>,
): Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
Trigger Sonarr webhook
Parameters
- data: Bazarr.Options<PostWebHooksSonarrData, boolean>
Returns Promise<
    | { data: unknown; request: Request; response: Response }
    | (
        ({ data: unknown; error: undefined; } | { data: undefined; error: unknown; }) & { request: Request; response: Response; }
    ),
>
- Defined in clients/bazarr.ts:676

updateConfig

updateConfig(
    newConfig: Partial<ServarrClientConfig>,
): {
    baseUrl: string;
    apiKey: string;
    timeout?: number;
    headers?: Record<string, string>;
}
Parameters
- newConfig: Partial<ServarrClientConfig>
Returns {
    baseUrl: string;
    apiKey: string;
    timeout?: number;
    headers?: Record<string, string>;
}
- Defined in clients/bazarr.ts:681

Class BazarrClient

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BazarrClient

Methods

getSystemStatus

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

getSystemHealth

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

ping

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

getSystemReleases

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

getSystemAnnouncements

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

dismissAnnouncement

Parameters

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

getSystemLogs

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

rotateLogs

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

getSystemTasks

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

runSystemTask

Parameters

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

getBackups

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

createBackup

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

restoreBackup

Parameters

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

deleteBackup

Parameters

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

getJobs

Parameters

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

manageJob

Parameters

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

deleteJob

Parameters

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

emptyJobQueue

Parameters

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

getLanguages

Parameters

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

getLanguageProfiles

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

getSeries

Parameters

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

updateSeriesLanguageProfile

Parameters

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

runSeriesAction

Parameters

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

getEpisodes

Parameters

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

getEpisodesWanted

Parameters

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

getEpisodesHistory

Parameters

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

downloadEpisodeSubtitles

Parameters

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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