You are reading the documentation for the in-development version of Streamlink.
Streamlink¶
Overview¶
Streamlink is a command-line utility which pipes video streams from various services into a video player, such as VLC or mpv. The main purpose of Streamlink is to avoid resource-heavy and unoptimized websites, while still allowing the user to enjoy various streamed content. There is also a Python API available for developers who want access to the stream data.
This project was forked from Livestreamer, which is no longer maintained.
- Latest release (7.0.0)
- GitHub
- Issue tracker
- Discussion forum
- Gitter/Matrix channel
- PyPI
- Free software
Simplified BSD license
Features¶
Streamlink is built on top of a plugin system which allows support for new services to be added easily. Most of the popular streaming services are supported, such as Twitch, YouTube, and many more.
A list of all plugins currently included can be found on the plugins page.
Quickstart¶
The default behavior of Streamlink is to play back streams in the VLC player.
$ streamlink twitch.tv/day9tv best
[cli][info] Found matching plugin twitch for URL twitch.tv/day9tv
[cli][info] Available streams: audio_only, 160p (worst), 360p, 480p, 720p, 720p60, 1080p60 (best)
[cli][info] Opening stream: 1080p60 (hls)
[cli][info] Starting player: vlc
For more in-depth usage and install instructions, please refer to the User guide.
User guide¶
Streamlink is made up of two parts, a cli and a library API. See their respective sections for more information on how to use them.
Thank you¶
Github, for hosting the git repo, docs, release assets and providing CI tools
Whatismybrowser, for the access to their user-agents API in our CI workflows
Table of contents¶
- Overview
- Installation
- Command-Line Interface
- Plugins
- abematv
- adultswim
- albavision
- aloula
- app17
- ard_live
- ard_mediathek
- artetv
- atpchallenger
- atresplayer
- bbciplayer
- bfmtv
- bigo
- bilibili
- blazetv
- bloomberg
- brightcove
- btv
- cbsnews
- cdnbg
- ceskatelevize
- chzzk
- cinergroup
- clubbingtv
- cmmedia
- cnbce
- cnews
- dailymotion
- delfi
- deutschewelle
- dlive
- dogan
- dogus
- douyin
- drdk
- earthcam
- euronews
- filmon
- goltelevision
- goodgame
- googledrive
- gulli
- hiplayer
- htv
- huajiao
- huya
- indihometv
- invintus
- kick
- kugou
- livestream
- lnk
- lrt
- ltv_lsm_lv
- mangomolo
- mdstrm
- mediaklikk
- mediavitrina
- mitele
- mixcloud
- mjunoon
- mrtmk
- n13tv
- nasaplus
- nhkworld
- nicolive
- nimotv
- nos
- nowtvtr
- nrk
- okru
- olympicchannel
- oneplusone
- onetv
- openrectv
- pandalive
- piaulizaportal
- picarto
- piczel
- pixiv
- pluto
- pluzz
- radiko
- raiplay
- reuters
- rtpa
- rtpplay
- rtve
- rtvs
- ruv
- sbscokr
- showroom
- soop
- sportal
- sportschau
- ssh101
- stadium
- steam
- streamable
- streann
- stv
- svtplay
- swisstxt
- telefe
- telemadrid
- tf1
- tiktok
- trovo
- turkuvaz
- tv360
- tv3cat
- tv4play
- tv5monde
- tv8
- tv999
- tvibo
- tviplayer
- tvp
- tvtoya
- twitcasting
- twitch
- ustreamtv
- ustvnow
- vidio
- vimeo
- vinhlongtv
- vk
- vkvideo
- vtvgo
- welt
- wwenetwork
- youtube
- yupptv
- zattoo
- zdf_mediathek
- zeenews
- Players
- Deprecations
- Migrations
- Developing
- API Guide
- API Reference
- Changelog
- streamlink 7.0.0 (2024-11-04)
- streamlink 6.11.0 (2024-10-01)
- streamlink 6.10.0 (2024-09-06)
- streamlink 6.9.0 (2024-08-12)
- streamlink 6.8.3 (2024-07-11)
- streamlink 6.8.2 (2024-07-04)
- streamlink 6.8.1 (2024-06-18)
- streamlink 6.8.0 (2024-06-17)
- streamlink 6.7.4 (2024-05-12)
- streamlink 6.7.3 (2024-04-14)
- streamlink 6.7.2 (2024-03-23)
- streamlink 6.7.1 (2024-03-19)
- streamlink 6.7.0 (2024-03-09)
- streamlink 6.6.2 (2024-02-20)
- streamlink 6.6.1 (2024-02-17)
- streamlink 6.6.0 (2024-02-16)
- streamlink 6.5.1 (2024-01-16)
- streamlink 6.5.0 (2023-12-16)
- streamlink 6.4.2 (2023-11-28)
- streamlink 6.4.1 (2023-11-22)
- streamlink 6.4.0 (2023-11-21)
- streamlink 6.3.1 (2023-10-26)
- streamlink 6.3.0 (2023-10-25)
- streamlink 6.2.1 (2023-10-03)
- streamlink 6.2.0 (2023-09-14)
- streamlink 6.1.0 (2023-08-16)
- streamlink 6.0.1 (2023-08-02)
- streamlink 6.0.0 (2023-07-20)
- streamlink 5.5.1 (2023-05-08)
- streamlink 5.5.0 (2023-05-05)
- streamlink 5.4.0 (2023-04-12)
- streamlink 5.3.1 (2023-02-25)
- streamlink 5.3.0 (2023-02-18)
- streamlink 5.2.1 (2023-01-23)
- streamlink 5.2.0 (2023-01-23)
- streamlink 5.1.2 (2022-12-03)
- streamlink 5.1.1 (2022-11-23)
- streamlink 5.1.0 (2022-11-14)
- streamlink 5.0.1 (2022-09-22)
- streamlink 5.0.0 (2022-09-16)
- streamlink 4.3.0 (2022-08-15)
- streamlink 4.2.0 (2022-07-09)
- streamlink 4.1.0 (2022-05-30)
- streamlink 4.0.1 (2022-05-01)
- streamlink 4.0.0 (2022-05-01)
- streamlink 3.2.0 (2022-03-05)
- streamlink 3.1.1 (2022-01-25)
- streamlink 3.1.0 (2022-01-22)
- streamlink 3.0.3 (2021-11-27)
- streamlink 3.0.2 (2021-11-25)
- streamlink 3.0.1 (2021-11-17)
- streamlink 3.0.0 (2021-11-17)
- streamlink 2.4.0 (2021-09-07)
- streamlink 2.3.0 (2021-07-26)
- streamlink 2.2.0 (2021-06-19)
- streamlink 2.1.2 (2021-05-20)
- streamlink 2.1.1 (2021-03-25)
- streamlink 2.1.0 (2021-03-22)
- streamlink 2.0.0 (2020-12-22)
- streamlink 1.7.0 (2020-10-18)
- streamlink 1.6.0 (2020-09-22)
- streamlink 1.5.0 (2020-07-07)
- streamlink 1.4.1 (2020-04-24)
- streamlink 1.4.0 (2020-04-22)
- streamlink 1.3.1 (2020-01-27)
- streamlink 1.3.0 (2019-11-22)
- streamlink 1.2.0 (2019-08-18)
- streamlink 1.1.1 (2019-04-02)
- streamlink 1.1.0 (2019-03-31)
- streamlink 1.0.0 (2019-01-30)
- streamlink 0.14.2 (2018-06-28)
- streamlink 0.14.0 (2018-06-26)
- streamlink 0.13.0 (2018-06-06)
- streamlink 0.12.1 (2018-05-07)
- streamlink 0.12.0 (2018-05-07)
- streamlink 0.11.0 (2018-03-08)
- streamlink 0.10.0 (2018-01-23)
- streamlink 0.9.0 (2017-11-14)
- streamlink 0.8.1 (2017-09-12)
- streamlink 0.7.0 (2017-06-30)
- streamlink 0.6.0 (2017-05-11)
- streamlink 0.5.0 (2017-04-04)
- streamlink 0.4.0 (2017-03-09)
- streamlink 0.3.2 (2017-02-10)
- streamlink 0.3.1 (2017-02-03)
- streamlink 0.3.0 (2017-01-24)
- streamlink 0.2.0 (2016-12-16)
- streamlink 0.1.0 (2016-11-21)
- streamlink 0.0.2 (2016-10-12)
- streamlink 0.0.1 (2016-09-23)
- Support
- Streamlink Applications
- Third Party Applications