starred/ytmusicapi
1
0
Fork 0
mirror of https://github.com/sigma67/ytmusicapi.git synced 2026-04-25 23:36:00 +03:00
Code Issues 26 Projects Releases 10 Packages Wiki Activity

[GH-ISSUE #127] KeyError from "search()", missing navigationEndpoint in album result #93

New issue
Closed
opened 2026-02-27 22:07:58 +03:00 by kerem · 1 comment
kerem commented 2026-02-27 22:07:58 +03:00
Owner
Copy link

Originally created by @wsidl on GitHub (Dec 17, 2020).
Original GitHub issue: https://github.com/sigma67/ytmusicapi/issues/127

Description

Running a search for track titles also returns album and artist results. "KeyError" is raised before the search function finishes.

Expected behaviour

results = yt.search("That's My Jam Skindred That's My Jam")
# parse results

Current behaviour

results = yt.search("That's My Jam Skindred That's My Jam")
Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/ytmusicapi/parsers/utils.py", line 167, in nav
    raise err
  File "/usr/lib/python3.8/site-packages/ytmusicapi/parsers/utils.py", line 161, in nav
    root = root[k]
KeyError: 'navigationEndpoint'

Stack Trace:

  File "/scratch.py", line 110, in find
    results = YT.search(search_term)
  File "/usr/lib/python3.8/site-packages/ytmusicapi/mixins/browsing.py", line 119, in search
    search_results.extend(self.parser.parse_search_results(results, type))
  File "/usr/lib/python3.8/site-packages/ytmusicapi/helpers.py", line 78, in _impl
    return method(self, *method_args, **method_kwargs)
  File "/usr/lib/python3.8/site-packages/ytmusicapi/parsers/browsing.py", line 36, in parse_search_results
    search_result['browseId'] = nav(data, NAVIGATION_BROWSE_ID)
  File "/usr/lib/python3.8/site-packages/ytmusicapi/parsers/utils.py", line 167, in nav
    raise err
  File "/usr/lib/python3.8/site-packages/ytmusicapi/parsers/utils.py", line 161, in nav
    root = root[k]
KeyError: 'navigationEndpoint'

Additional Points

It does successfully parse many results, but gets stuck on an album entry.

nav(root, items, none_if_absent)
none_if_absent = False
items = ['navigationEndpoint', 'browseEndpoint', 'browseId']
root = {
	"trackingParams": "CLcBENjyAxgAIhMInoX5jfPV7QIV1YDECh09kgSk",
	"thumbnail": {
		"musicThumbnailRenderer": {
			"thumbnail": {
				"thumbnails": [
					{"url": "https://lh3.googleusercontent.com/FRFyrsX2NYZqwQmazxCOIx6rCW-KvLMSNlB0SJ0Nm39pGNeDiE1h3Koka9FPALCXwE7-ArSd1lIFfQrv=w60-h60-l90-rj", "width": 60, "height": 60},
					{"url": "https://lh3.googleusercontent.com/FRFyrsX2NYZqwQmazxCOIx6rCW-KvLMSNlB0SJ0Nm39pGNeDiE1h3Koka9FPALCXwE7-ArSd1lIFfQrv=w120-h120-l90-rj", "width": 120, "height": 120}
				]
			},
			"thumbnailCrop": "MUSIC_THUMBNAIL_CROP_UNSPECIFIED",
			"thumbnailScale": "MUSIC_THUMBNAIL_SCALE_ASPECT_FIT",
			"trackingParams": "CLkBEIS_AiITCJ6F-Y3z1e0CFdWAxAodPZIEpA=="
		}
	},
	"overlay": {
		"musicItemThumbnailOverlayRenderer": {
			"background": {
				"verticalGradient": {
					"gradientLayerColors": ["3422552064", "3422552064"]
				}
			},
			"content": {
				"musicPlayButtonRenderer": {
					"trackingParams": "CLgBEMjeAiITCJ6F-Y3z1e0CFdWAxAodPZIEpA==",
					"playIcon": {"iconType": "PLAY_ARROW"},
					"pauseIcon": {"iconType": "PAUSE"},
					"iconColor": 4294967295,
					"backgroundColor": 0,
					"activeBackgroundColor": 0,
					"loadingIndicatorColor": 4294901760,
					"playingIcon": {"iconType": "VOLUME_UP"},
					"iconLoadingColor": 0,
					"activeScaleFactor": 1,
					"buttonSize": "MUSIC_PLAY_BUTTON_SIZE_SMALL",
					"rippleTarget": "MUSIC_PLAY_BUTTON_RIPPLE_TARGET_SELF"
				}
			},
			"contentPosition": "MUSIC_ITEM_THUMBNAIL_OVERLAY_CONTENT_POSITION_CENTERED",
			"displayStyle": "MUSIC_ITEM_THUMBNAIL_OVERLAY_DISPLAY_STYLE_PERSISTENT"
		}
	},
	"flexColumns": [
		{
			"musicResponsiveListItemFlexColumnRenderer": {
				"text": {"runs": [{"text": "That's My Jam"}]},
				"displayPriority": "MUSIC_RESPONSIVE_LIST_ITEM_COLUMN_DISPLAY_PRIORITY_HIGH"
			}
		},
		{
			"musicResponsiveListItemFlexColumnRenderer": {
				"text": {
					"runs": [
						{"text": "Skindred"},
						{"text": " • "},
						{"text": "3:17"}
					]
				},
				"displayPriority": "MUSIC_RESPONSIVE_LIST_ITEM_COLUMN_DISPLAY_PRIORITY_HIGH"
			}
		}
	],
	"flexColumnDisplayStyle": "MUSIC_RESPONSIVE_LIST_ITEM_FLEX_COLUMN_DISPLAY_STYLE_TWO_LINE_STACK",
	"itemHeight": "MUSIC_RESPONSIVE_LIST_ITEM_HEIGHT_TALL",
	"musicItemRendererDisplayPolicy": "MUSIC_ITEM_RENDERER_DISPLAY_POLICY_GREY_OUT"
}

_version.py

__version__ = "0.12.1"
Originally created by @wsidl on GitHub (Dec 17, 2020). Original GitHub issue: https://github.com/sigma67/ytmusicapi/issues/127 ## Description Running a search for track titles also returns album and artist results. "KeyError" is raised before the search function finishes. ## Expected behaviour ```python results = yt.search("That's My Jam Skindred That's My Jam") # parse results ``` ## Current behaviour ```python results = yt.search("That's My Jam Skindred That's My Jam") Traceback (most recent call last): File "/usr/lib/python3.8/site-packages/ytmusicapi/parsers/utils.py", line 167, in nav raise err File "/usr/lib/python3.8/site-packages/ytmusicapi/parsers/utils.py", line 161, in nav root = root[k] KeyError: 'navigationEndpoint' ``` Stack Trace: ``` File "/scratch.py", line 110, in find results = YT.search(search_term) File "/usr/lib/python3.8/site-packages/ytmusicapi/mixins/browsing.py", line 119, in search search_results.extend(self.parser.parse_search_results(results, type)) File "/usr/lib/python3.8/site-packages/ytmusicapi/helpers.py", line 78, in _impl return method(self, *method_args, **method_kwargs) File "/usr/lib/python3.8/site-packages/ytmusicapi/parsers/browsing.py", line 36, in parse_search_results search_result['browseId'] = nav(data, NAVIGATION_BROWSE_ID) File "/usr/lib/python3.8/site-packages/ytmusicapi/parsers/utils.py", line 167, in nav raise err File "/usr/lib/python3.8/site-packages/ytmusicapi/parsers/utils.py", line 161, in nav root = root[k] KeyError: 'navigationEndpoint' ``` ## Additional Points It does successfully parse many results, but gets stuck on an album entry. ``` nav(root, items, none_if_absent) none_if_absent = False items = ['navigationEndpoint', 'browseEndpoint', 'browseId'] root = { "trackingParams": "CLcBENjyAxgAIhMInoX5jfPV7QIV1YDECh09kgSk", "thumbnail": { "musicThumbnailRenderer": { "thumbnail": { "thumbnails": [ {"url": "https://lh3.googleusercontent.com/FRFyrsX2NYZqwQmazxCOIx6rCW-KvLMSNlB0SJ0Nm39pGNeDiE1h3Koka9FPALCXwE7-ArSd1lIFfQrv=w60-h60-l90-rj", "width": 60, "height": 60}, {"url": "https://lh3.googleusercontent.com/FRFyrsX2NYZqwQmazxCOIx6rCW-KvLMSNlB0SJ0Nm39pGNeDiE1h3Koka9FPALCXwE7-ArSd1lIFfQrv=w120-h120-l90-rj", "width": 120, "height": 120} ] }, "thumbnailCrop": "MUSIC_THUMBNAIL_CROP_UNSPECIFIED", "thumbnailScale": "MUSIC_THUMBNAIL_SCALE_ASPECT_FIT", "trackingParams": "CLkBEIS_AiITCJ6F-Y3z1e0CFdWAxAodPZIEpA==" } }, "overlay": { "musicItemThumbnailOverlayRenderer": { "background": { "verticalGradient": { "gradientLayerColors": ["3422552064", "3422552064"] } }, "content": { "musicPlayButtonRenderer": { "trackingParams": "CLgBEMjeAiITCJ6F-Y3z1e0CFdWAxAodPZIEpA==", "playIcon": {"iconType": "PLAY_ARROW"}, "pauseIcon": {"iconType": "PAUSE"}, "iconColor": 4294967295, "backgroundColor": 0, "activeBackgroundColor": 0, "loadingIndicatorColor": 4294901760, "playingIcon": {"iconType": "VOLUME_UP"}, "iconLoadingColor": 0, "activeScaleFactor": 1, "buttonSize": "MUSIC_PLAY_BUTTON_SIZE_SMALL", "rippleTarget": "MUSIC_PLAY_BUTTON_RIPPLE_TARGET_SELF" } }, "contentPosition": "MUSIC_ITEM_THUMBNAIL_OVERLAY_CONTENT_POSITION_CENTERED", "displayStyle": "MUSIC_ITEM_THUMBNAIL_OVERLAY_DISPLAY_STYLE_PERSISTENT" } }, "flexColumns": [ { "musicResponsiveListItemFlexColumnRenderer": { "text": {"runs": [{"text": "That's My Jam"}]}, "displayPriority": "MUSIC_RESPONSIVE_LIST_ITEM_COLUMN_DISPLAY_PRIORITY_HIGH" } }, { "musicResponsiveListItemFlexColumnRenderer": { "text": { "runs": [ {"text": "Skindred"}, {"text": " • "}, {"text": "3:17"} ] }, "displayPriority": "MUSIC_RESPONSIVE_LIST_ITEM_COLUMN_DISPLAY_PRIORITY_HIGH" } } ], "flexColumnDisplayStyle": "MUSIC_RESPONSIVE_LIST_ITEM_FLEX_COLUMN_DISPLAY_STYLE_TWO_LINE_STACK", "itemHeight": "MUSIC_RESPONSIVE_LIST_ITEM_HEIGHT_TALL", "musicItemRendererDisplayPolicy": "MUSIC_ITEM_RENDERER_DISPLAY_POLICY_GREY_OUT" } ``` _version.py ```python __version__ = "0.12.1" ```
kerem closed this issue 2026-02-27 22:07:58 +03:00
kerem commented 2026-02-27 22:07:59 +03:00
Author
Owner
Copy link

@sigma67 commented on GitHub (Dec 18, 2020):

The search query you listed works fine for me. I'm not sure why the album would be missing the browseId.

In your PR you mention the item in question is uploaded or private. How could an uploaded item appear in normal search? As far as I'm aware regular YTMusic songs are strictly separated from uploaded/private items.

Edit: Never mind, I have found another search query to reproduce this.

<!-- gh-comment-id:748012315 --> @sigma67 commented on GitHub (Dec 18, 2020): The search query you listed works fine for me. I'm not sure why the album would be missing the browseId. In your PR you mention the item in question is uploaded or private. How could an uploaded item appear in normal search? As far as I'm aware regular YTMusic songs are strictly separated from uploaded/private items. Edit: Never mind, I have found another search query to reproduce this.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
fix-yt-dlp-link
restore-codecov-cat
unify-coverage-workflow
sigma67-security-md
rewrite-workflow
dep/update-pdm-lock
remove-2025-explore-test
get-explore-fix-top-episodes-duration
update-linters
fix-ci-pipeline
fix-827
remove-oauth-account-tests
fix-tests
fix-799
fix-remaining-tests
v2
niquests
3-10-typed
fix-758
fix-743
fix-734-continuations
add-oauthcredentials-import-doc
ytmusic-auth-refactor
fix-720
fix-721
fix-713
fix-703
add-test-analytics
update-oauth-docs
feat-670
heinrich26-patch-1
fix-675
fix-get-history
fix-648
fix-641
refactor-use-pathlib
fix-647
fix-642
fix-640
fix-633
feat-628
fix-625
models
introduce-exception-classes
improve-coverage
pytest-retry
fix-588
fix-587
fix-582
fix-569
fix-get-playlist-562
get-artist-shows
get-podcast-playlist
fix-get-album-544
library-podcasts
get-episode-progress
fix-548
brand-account-setup
album-data-mining
jcbirdwell-album-data-mining
album-data-mining-fixes
get-podcast
artist-albums-continuations
1.11.5
1.11.4
1.11.3
1.11.2
1.11.1
1.11.0
1.11.0rc1
1.10.3
1.10.2
1.10.1
1.10.0
1.9.1
1.9.0
1.8.2
1.8.1
1.8.0
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.0
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.2
1.4.1
1.4.0
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.1.1
1.1.0
1.0.2
1.0.1
1.0.0
0.25.2
0.25.1
0.25.0
0.24.1
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.5
0.19.4
0.19.3
0.19.2
0.19.1
0.19.0
0.18.0
0.17.3
0.17.2
0.17.1
0.17.0
0.16.0
0.15.1
0.15.0
0.14.3
0.14.2
0.14.1
0.14.0
0.13.1
0.13.0
0.12.2
0.12.1
0.12.0
0.11.0
0.10.2
0.10.1
0.10.0
0.9.2
0.9.1
0.9.0
0.8.1
0.8.0
0.7.1
0.7.0
0.6.1
0.6.0
0.5.2
0.5.1
0.5.0
0.4.3
0.4.2
8cc1986
0.4.1
1ac614e
Labels
Clear labels   
a/b

   
bug

   
documentation

   
enhancement

   
good first issue

   
help wanted

   
invalid

   
pull-request

Mirrored from GitHub Pull Request

  
question

   
wontfix

   
yt-error

   
yt-update
No labels
a/b
bug
documentation
enhancement
good first issue
help wanted
invalid
pull-request
question
wontfix
yt-error
yt-update
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/ytmusicapi#93
No description provided.