Python API client for Jellyfin
Jellyfin ApiClient Python
This is the API client from Jellyfin Kodi extracted as a python package so that other users may use the API without maintaining a fork of the API client. Please note that this API client is not complete. You may have to add API calls to perform certain tasks. Please see Contributing below.
This client can be installed with
pip3 install jellyfin-apiclient-python and imported with
There is no documentation for this API at this time. For information on how to create a client and establish a session, please see clients.py from Jellyfin MPV Shim. For details on what the individual API calls do or how to do a certain task, you will probably find the Jellyfin MPV Shim and Jellyfin Kodi repositories useful.
Changes from Jellyfin Kodi
- Removal of
websocket.py(now a dependency to
- Removal of dependencies on
helper(from Jellyfin Kodi) and
- Add API calls:
get_seasonfor fetching season metadata.
get_audio_streamto read an audio stream into a file
search_media_itemsto search for media items
audio_urlto return the URL to an audio file
- Add parameters
aid=None, sid=None, start_time_ticks=None, is_playback=Trueto API call
- Add timesync manager and SyncPlay API methods.
When contributing, please maintain backward compatibility with existing calls in the API. Adding parameters is fine, but please make sure that they have default options to prevent existing software from breaking. Please also add your changes to the Changes from Jellyfin Kodi section.
If you would like to produce documentation for this API, I would also be interested in accepting pull requests for documentation.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for jellyfin-apiclient-python-1.8.1.tar.gz
Hashes for jellyfin_apiclient_python-1.8.1-py3-none-any.whl