Dispatcharr

Note

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

class pyarr._sync.dispatcharr.Dispatcharr(host: str, api_key: str, port: int = 9191, tls: bool = True, base_path: str = '', request_timeout: int | None = None, api_ver: str | None = 'v1')[source]: Dispatcharr API client.

Channels

class pyarr._sync.dispatcharr.channels.Channels(handler: RequestHandler)[source]

Channel actions for Dispatcharr.

get(item_id: int | None = None) → list[dict[str, Any]] | dict[str, Any][source]

Returns the list of channels or a specific channel by ID.

Parameters:: item_id (int | None, optional) – ID of the channel to return. Defaults to None.
Returns:: The response data.
Return type:: JsonArray | JsonObject

add(data: dict[str, Any]) → dict[str, Any][source]

Add a new channel.

Parameters:: data (JsonObject) – Channel configuration.
Returns:: Added channel details.
Return type:: JsonObject

update(item_id: int, data: dict[str, Any]) → dict[str, Any][source]

Update an existing channel.

Parameters:

item_id (int) – Channel ID.
data (JsonObject) – Updated configuration.

Returns:

Updated channel details.

Return type:

JsonObject

delete(item_id: int) → None[source]

Delete a channel.

Parameters:: item_id (int) – Channel ID.

Streams

class pyarr._sync.dispatcharr.streams.Streams(handler: RequestHandler)[source]

Stream actions for Dispatcharr.

get(item_id: int | None = None) → list[dict[str, Any]] | dict[str, Any][source]

Returns the list of streams or a specific stream by ID.

Parameters:: item_id (int | None, optional) – ID of the stream to return. Defaults to None.
Returns:: The response data.
Return type:: JsonArray | JsonObject

add(data: dict[str, Any]) → dict[str, Any][source]

Add a new stream.

Parameters:: data (JsonObject) – Stream configuration.
Returns:: Added stream details.
Return type:: JsonObject

update(item_id: int, data: dict[str, Any]) → dict[str, Any][source]

Update an existing stream.

Parameters:

item_id (int) – Stream ID.
data (JsonObject) – Updated configuration.

Returns:

Updated stream details.

Return type:

JsonObject

delete(item_id: int) → None[source]

Delete a stream.

Parameters:: item_id (int) – Stream ID.

Vod

class pyarr._sync.dispatcharr.vod.Vod(handler: RequestHandler)[source]

VOD actions for Dispatcharr.

get(item_id: int | None = None) → list[dict[str, Any]] | dict[str, Any][source]

Returns the list of VOD content or a specific item by ID.

Parameters:: item_id (int | None, optional) – ID of the VOD item to return. Defaults to None.
Returns:: The response data.
Return type:: JsonArray | JsonObject

add(data: dict[str, Any]) → dict[str, Any][source]

Add a new VOD item.

Parameters:: data (JsonObject) – VOD configuration.
Returns:: Added VOD details.
Return type:: JsonObject

update(item_id: int, data: dict[str, Any]) → dict[str, Any][source]

Update an existing VOD item.

Parameters:

item_id (int) – VOD ID.
data (JsonObject) – Updated configuration.

Returns:

Updated VOD details.

Return type:

JsonObject

delete(item_id: int) → None[source]

Delete a VOD item.

Parameters:: item_id (int) – VOD ID.