Bazarr

Note

An asynchronous version of this client is available as AsyncBazarr. The API is identical, but all methods are coroutines and must be awaited.

class pyarr._sync.bazarr.Bazarr(host: str, api_key: str, port: int = 6767, tls: bool = True, base_path: str = '', request_timeout: int | None = None, api_ver: str | None = '')[source]

Bazarr API client.

Providers

class pyarr._sync.bazarr.providers.Providers(handler: RequestHandler)[source]

Subtitle provider actions for Bazarr.

get() list[dict[str, Any]][source]

Returns the list of subtitle providers.

Returns:

List of dictionaries with items.

Return type:

JsonArray

Subtitles

class pyarr._sync.bazarr.subtitles.Subtitles(handler: RequestHandler)[source]

Subtitle actions for Bazarr.

get(**kwargs) list[dict[str, Any]][source]

Returns the list of subtitles.

Parameters:

**kwargs – Additional parameters for filtering.

Returns:

List of dictionaries with items.

Return type:

JsonArray

download(subtitle_id: str) dict[str, Any][source]

Download a specific subtitle.

Parameters:

subtitle_id (str) – ID of the subtitle to download.

Returns:

Download status.

Return type:

JsonObject

delete(subtitle_id: str) None[source]

Delete a specific subtitle.

Parameters:

subtitle_id (str) – ID of the subtitle to delete.