# innertube
Python Client for Google's Private InnerTube API. Works with **YouTube**, **YouTube Music**, **YouTube Kids**, **YouTube Studio** and more!
## About
This library handles low-level interactions with the underlying InnerTube API used by each of the YouTube services.
Here are a few articles available online relating to the InnerTube API:
* [Gizmodo - How Project InnerTube Helped Pull YouTube Out of the Gutter](https://gizmodo.com/how-project-innertube-helped-pull-youtube-out-of-the-gu-1704946491)
* [Fast Company - To Take On HBO And Netflix, YouTube Had To Rewire Itself](https://www.fastcompany.com/3044995/to-take-on-hbo-and-netflix-youtube-had-to-rewire-itself)
## Installation
`innertube` uses [Poetry](https://github.com/python-poetry/poetry) under the hood and can easily be installed from source or from PyPI using *pip*.
### Latest Release
```console
pip install innertube
```
### Bleeding Edge
```console
pip install git+https://github.com/tombulled/innertube@develop
```
## Usage
```python
>>> import innertube
>>>
>>> # Construct a client
>>> client = innertube.InnerTube("WEB")
>>>
>>> # Get some data!
>>> data = client.search(query="foo fighters")
>>>
>>> # Power user? No problem, dispatch requests yourself
>>> data = client("browse", body={"browseId": "FEwhat_to_watch"})
>>>
>>> # The core endpoints are implemented, so the above is equivalent to:
>>> data = client.browse("FEwhat_to_watch")
```
## Comparison with the [YouTube Data API](https://developers.google.com/youtube/v3/)
The InnerTube API provides access to data you can't get from the Data API, however it comes at somewhat of a cost *(explained below)*.
| | This Library | YouTube Data API |
| ------------------------------------- | ------------ | ---------------- |
| Google account required | No | Yes |
| Request limit | No | Yes |
| Clean data | No | Yes |
The InnerTube API is used by a variety of YouTube services and is not designed for consumption by users. Therefore, the data returned by the InnerTube API will need to be parsed and sanitised to extract data of interest.
## Endpoints
Currently only the following core, unauthenticated endpoints are implemented:
| | YouTube | YouTubeMusic | YouTubeKids | YouTubeStudio |
| ------------------------------ | ------- | ------------ | ----------- | ------------- |
| config | ✓ | ✓ | ✓ | ✓ |
| browse | ✓ | ✓ | ✓ | ✓ |
| player | ✓ | ✓ | ✓ | ✓ |
| next | ✓ | ✓ | ✓ | |
| search | ✓ | ✓ | ✓ | |
| guide | ✓ | ✓ | | |
| get_transcript | ✓ | | | |
| music/get_search_suggestions | | ✓ | | |
| music/get_queue | | ✓ | | |
## Authentication
The InnerTube API uses OAuth2, however this has not yet been implemented, therefore this library currently only provides unauthenticated API access.
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/innertube/",
"name": "innertube",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "innertube, youtube, youtubei, python, api, client",
"author": "Tom Bulled",
"author_email": "26026015+tombulled@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/84/65/72d29b66b30c82b79ba52f7aadcdf7940afe49d0a3887fa156b55101d5fd/innertube-2.1.16.tar.gz",
"platform": null,
"description": "# innertube\nPython Client for Google's Private InnerTube API. Works with **YouTube**, **YouTube Music**, **YouTube Kids**, **YouTube Studio** and more!\n\n## About\nThis library handles low-level interactions with the underlying InnerTube API used by each of the YouTube services.\n\nHere are a few articles available online relating to the InnerTube API:\n* [Gizmodo - How Project InnerTube Helped Pull YouTube Out of the Gutter](https://gizmodo.com/how-project-innertube-helped-pull-youtube-out-of-the-gu-1704946491)\n* [Fast Company - To Take On HBO And Netflix, YouTube Had To Rewire Itself](https://www.fastcompany.com/3044995/to-take-on-hbo-and-netflix-youtube-had-to-rewire-itself)\n\n## Installation\n`innertube` uses [Poetry](https://github.com/python-poetry/poetry) under the hood and can easily be installed from source or from PyPI using *pip*.\n\n### Latest Release\n```console\npip install innertube\n```\n\n### Bleeding Edge\n```console\npip install git+https://github.com/tombulled/innertube@develop\n```\n\n## Usage\n```python\n>>> import innertube\n>>>\n>>> # Construct a client\n>>> client = innertube.InnerTube(\"WEB\")\n>>>\n>>> # Get some data!\n>>> data = client.search(query=\"foo fighters\")\n>>>\n>>> # Power user? No problem, dispatch requests yourself\n>>> data = client(\"browse\", body={\"browseId\": \"FEwhat_to_watch\"})\n>>>\n>>> # The core endpoints are implemented, so the above is equivalent to:\n>>> data = client.browse(\"FEwhat_to_watch\")\n```\n\n## Comparison with the [YouTube Data API](https://developers.google.com/youtube/v3/)\nThe InnerTube API provides access to data you can't get from the Data API, however it comes at somewhat of a cost *(explained below)*.\n| | This Library | YouTube Data API |\n| ------------------------------------- | ------------ | ---------------- |\n| Google account required | No | Yes |\n| Request limit | No | Yes |\n| Clean data | No | Yes |\n\nThe InnerTube API is used by a variety of YouTube services and is not designed for consumption by users. Therefore, the data returned by the InnerTube API will need to be parsed and sanitised to extract data of interest.\n\n## Endpoints\nCurrently only the following core, unauthenticated endpoints are implemented:\n| | YouTube | YouTubeMusic | YouTubeKids | YouTubeStudio |\n| ------------------------------ | ------- | ------------ | ----------- | ------------- |\n| config | ✓ | ✓ | ✓ | ✓ |\n| browse | ✓ | ✓ | ✓ | ✓ |\n| player | ✓ | ✓ | ✓ | ✓ |\n| next | ✓ | ✓ | ✓ | |\n| search | ✓ | ✓ | ✓ | |\n| guide | ✓ | ✓ | | |\n| get_transcript | ✓ | | | |\n| music/get_search_suggestions | | ✓ | | |\n| music/get_queue | | ✓ | | |\n\n## Authentication\nThe InnerTube API uses OAuth2, however this has not yet been implemented, therefore this library currently only provides unauthenticated API access.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Client for Google's Private InnerTube API. Works with Youtube, YouTube Music and more!",
"version": "2.1.16",
"project_urls": {
"Homepage": "https://pypi.org/project/innertube/",
"Repository": "https://github.com/tombulled/innertube"
},
"split_keywords": [
"innertube",
" youtube",
" youtubei",
" python",
" api",
" client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0bc89babe96d05d94eddc87b0f981937bcdb710485a0526c39c6bb442053ffdb",
"md5": "256e9b0f5b2f316434f1606bdaedd9bc",
"sha256": "5a009eca80f3f588ba840d36fb0de388d8734d4a2d28545018b2989abeb5a57a"
},
"downloads": -1,
"filename": "innertube-2.1.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "256e9b0f5b2f316434f1606bdaedd9bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 11795,
"upload_time": "2024-05-11T20:34:58",
"upload_time_iso_8601": "2024-05-11T20:34:58.588994Z",
"url": "https://files.pythonhosted.org/packages/0b/c8/9babe96d05d94eddc87b0f981937bcdb710485a0526c39c6bb442053ffdb/innertube-2.1.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "846572d29b66b30c82b79ba52f7aadcdf7940afe49d0a3887fa156b55101d5fd",
"md5": "8bd10c4c01b459e9141ba926fbf0f415",
"sha256": "d8d3fba018ae175607c9b9fd051f9ac64aeddff6acfa74e498236f7777c911c2"
},
"downloads": -1,
"filename": "innertube-2.1.16.tar.gz",
"has_sig": false,
"md5_digest": "8bd10c4c01b459e9141ba926fbf0f415",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 10546,
"upload_time": "2024-05-11T20:35:00",
"upload_time_iso_8601": "2024-05-11T20:35:00.530206Z",
"url": "https://files.pythonhosted.org/packages/84/65/72d29b66b30c82b79ba52f7aadcdf7940afe49d0a3887fa156b55101d5fd/innertube-2.1.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-11 20:35:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tombulled",
"github_project": "innertube",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "innertube"
}
JSON
