spotifywebapiPython 1.0.259__py3-none-any.whl → 1.0.261__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- spotifywebapipython/__init__.py +2 -0
- spotifywebapipython/const.py +1 -1
- spotifywebapipython/docs/__init__.html +23 -2
- spotifywebapipython/docs/index.html +8 -2
- spotifywebapipython/docs/search.js +1 -1
- spotifywebapipython/docs/spotifywebapipython/const.html +3 -3
- spotifywebapipython/docs/spotifywebapipython/saappmessages.html +26 -8
- spotifywebapipython/docs/spotifywebapipython/sautils.html +2 -2
- spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html +2 -2
- spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html +2 -2
- spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html +2 -2
- spotifywebapipython/docs/spotifywebapipython/spotifyclient.html +494 -82
- spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html +2 -2
- spotifywebapipython/docs/spotifywebapipython/spotifymediatypes.html +441 -0
- spotifywebapipython/docs/spotifywebapipython/spotifytypeprefixes.html +458 -0
- spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html +2 -2
- spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html +2 -2
- spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html +2 -2
- spotifywebapipython/models/zeroconfdiscoveryresult.py +1 -1
- spotifywebapipython/saappmessages.py +6 -1
- spotifywebapipython/spotifyclient.py +1020 -344
- spotifywebapipython/spotifyconnect/spotifyconnectdirectorytask.py +64 -7
- spotifywebapipython/spotifyconnect/spotifyconnectzeroconfcastapptask.py +6 -0
- spotifywebapipython/spotifyconnect/spotifyconnectzeroconfcastcontroller.py +42 -13
- spotifywebapipython/spotifyconnect/spotifyconnectzeroconfcastlistener.py +12 -0
- spotifywebapipython/spotifymediatypes.py +10 -10
- spotifywebapipython/spotifytypeprefixes.py +65 -0
- {spotifywebapipython-1.0.259.dist-info → spotifywebapipython-1.0.261.dist-info}/METADATA +1 -1
- {spotifywebapipython-1.0.259.dist-info → spotifywebapipython-1.0.261.dist-info}/RECORD +32 -29
- {spotifywebapipython-1.0.259.dist-info → spotifywebapipython-1.0.261.dist-info}/LICENSE +0 -0
- {spotifywebapipython-1.0.259.dist-info → spotifywebapipython-1.0.261.dist-info}/WHEEL +0 -0
- {spotifywebapipython-1.0.259.dist-info → spotifywebapipython-1.0.261.dist-info}/top_level.txt +0 -0
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
</title>
|
|
10
10
|
<link rel="icon" type="image/svg+xml" href="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612-2.021%201.25-.079.295.021.601.274.837.219.203.415.364.598.501-.667.304-1.243.698-1.311%201.179-.02.144-.022.507.393.787.213.144.395.26.564.365-1.285.521-1.361.96-1.381%201.126-.018.142-.011.496.427.746l.854.489c-.473.389-.971.914-.999%201.429-.018.278.095.532.316.713.675.556%201.231.721%201.653.721.059%200%20.104-.014.158-.02.207.707.641%201.64%201.513%201.64h.013c.8-.008%201.236-.345%201.462-.626.173-.216.268-.457.325-.692.424.195.93.374%201.372.374.151%200%20.294-.021.423-.068.732-.27.944-.704.993-1.021.009-.061.003-.119.002-.179.266.086.538.147.789.147.15%200%20.294-.021.423-.069.542-.2.797-.489.914-.754.237.147.478.258.704.288.106.014.205.021.296.021.356%200%20.595-.101.767-.229.438.435%201.094.992%201.656%201.067.106.014.205.021.296.021a1.56%201.56%200%200%200%20.323-.035c.17.575.453%201.289.866%201.605.358.273.665.362.914.362a.99.99%200%200%200%20.421-.093%201.03%201.03%200%200%200%20.245-.164c.168.428.39.846.68%201.068.358.273.665.362.913.362a.99.99%200%200%200%20.421-.093c.317-.148.512-.448.639-.762.251.157.495.257.726.257.127%200%20.25-.024.37-.071.427-.17.706-.617.841-1.314.022-.015.047-.022.068-.038.067-.051.133-.104.196-.159-.443%201.486-1.107%202.761-2.086%203.257zM8.66%209.925a.5.5%200%201%200-1%200c0%20.653-.818%201.205-1.787%201.205s-1.787-.552-1.787-1.205a.5.5%200%201%200-1%200c0%201.216%201.25%202.205%202.787%202.205s2.787-.989%202.787-2.205zm4.4%2015.965l-.208.097c-2.661%201.258-4.708%201.436-6.086.527-1.542-1.017-1.88-3.19-1.844-4.198a.4.4%200%200%200-.385-.414c-.242-.029-.406.164-.414.385-.046%201.249.367%203.686%202.202%204.896.708.467%201.547.7%202.51.7%201.248%200%202.706-.392%204.362-1.174l.185-.086a.4.4%200%200%200%20.205-.527c-.089-.204-.326-.291-.527-.206zM9.547%202.292c.093.077.205.114.317.114a.5.5%200%200%200%20.318-.886L8.817.397a.5.5%200%200%200-.703.068.5.5%200%200%200%20.069.703l1.364%201.124zm-7.661-.065c.086%200%20.173-.022.253-.068l1.523-.893a.5.5%200%200%200-.506-.863l-1.523.892a.5.5%200%200%200-.179.685c.094.158.261.247.432.247z%22%20transform%3D%22matrix%28-1%200%200%201%2058%200%29%22%20fill%3D%22%233bb300%22/%3E%3Cpath%20d%3D%22M.3%2021.86V10.18q0-.46.02-.68.04-.22.18-.5.28-.54%201.34-.54%201.06%200%201.42.28.38.26.44.78.76-1.04%202.38-1.04%201.64%200%203.1%201.54%201.46%201.54%201.46%203.58%200%202.04-1.46%203.58-1.44%201.54-3.08%201.54-1.64%200-2.38-.92v4.04q0%20.46-.04.68-.02.22-.18.5-.14.3-.5.42-.36.12-.98.12-.62%200-1-.12-.36-.12-.52-.4-.14-.28-.18-.5-.02-.22-.02-.68zm3.96-9.42q-.46.54-.46%201.18%200%20.64.46%201.18.48.52%201.2.52.74%200%201.24-.52.52-.52.52-1.18%200-.66-.48-1.18-.48-.54-1.26-.54-.76%200-1.22.54zm14.741-8.36q.16-.3.54-.42.38-.12%201-.12.64%200%201.02.12.38.12.52.42.16.3.18.54.04.22.04.68v11.94q0%20.46-.04.7-.02.22-.18.5-.3.54-1.7.54-1.38%200-1.54-.98-.84.96-2.34.96-1.8%200-3.28-1.56-1.48-1.58-1.48-3.66%200-2.1%201.48-3.68%201.5-1.58%203.28-1.58%201.48%200%202.3%201v-4.2q0-.46.02-.68.04-.24.18-.52zm-3.24%2010.86q.52.54%201.26.54.74%200%201.22-.54.5-.54.5-1.18%200-.66-.48-1.22-.46-.56-1.26-.56-.8%200-1.28.56-.48.54-.48%201.2%200%20.66.52%201.2zm7.833-1.2q0-2.4%201.68-3.96%201.68-1.56%203.84-1.56%202.16%200%203.82%201.56%201.66%201.54%201.66%203.94%200%201.66-.86%202.96-.86%201.28-2.1%201.9-1.22.6-2.54.6-1.32%200-2.56-.64-1.24-.66-2.1-1.92-.84-1.28-.84-2.88zm4.18%201.44q.64.48%201.3.48.66%200%201.32-.5.66-.5.66-1.48%200-.98-.62-1.46-.62-.48-1.34-.48-.72%200-1.34.5-.62.5-.62%201.48%200%20.96.64%201.46zm11.412-1.44q0%20.84.56%201.32.56.46%201.18.46.64%200%201.18-.36.56-.38.9-.38.6%200%201.46%201.06.46.58.46%201.04%200%20.76-1.1%201.42-1.14.8-2.8.8-1.86%200-3.58-1.34-.82-.64-1.34-1.7-.52-1.08-.52-2.36%200-1.3.52-2.34.52-1.06%201.34-1.7%201.66-1.32%203.54-1.32.76%200%201.48.22.72.2%201.06.4l.32.2q.36.24.56.38.52.4.52.92%200%20.5-.42%201.14-.72%201.1-1.38%201.1-.38%200-1.08-.44-.36-.34-1.04-.34-.66%200-1.24.48-.58.48-.58%201.34z%22%20fill%3D%22green%22/%3E%3C/svg%3E"/>
|
|
11
11
|
<!-- build env - Package Name = "spotifywebapipython" -->
|
|
12
|
-
<!-- build env - Package Version = "1.0.
|
|
12
|
+
<!-- build env - Package Version = "1.0.261" -->
|
|
13
13
|
<!-- pdoc module.modulename = "spotifywebapipython.spotifyclient" -->
|
|
14
14
|
<!-- pdoc module.is_package = "False" -->
|
|
15
15
|
<!-- pdoc root_module_name = "None" -->
|
|
@@ -159,6 +159,9 @@
|
|
|
159
159
|
<li>
|
|
160
160
|
<a class="function" href="#SpotifyClient.CheckTrackFavorites">CheckTrackFavorites</a>
|
|
161
161
|
</li>
|
|
162
|
+
<li>
|
|
163
|
+
<a class="function" href="#SpotifyClient.CheckUserFavorites">CheckUserFavorites</a>
|
|
164
|
+
</li>
|
|
162
165
|
<li>
|
|
163
166
|
<a class="function" href="#SpotifyClient.CheckUsersFollowing">CheckUsersFollowing</a>
|
|
164
167
|
</li>
|
|
@@ -453,6 +456,9 @@
|
|
|
453
456
|
<li>
|
|
454
457
|
<a class="function" href="#SpotifyClient.RemoveTrackFavorites">RemoveTrackFavorites</a>
|
|
455
458
|
</li>
|
|
459
|
+
<li>
|
|
460
|
+
<a class="function" href="#SpotifyClient.RemoveUserFavorites">RemoveUserFavorites</a>
|
|
461
|
+
</li>
|
|
456
462
|
<li>
|
|
457
463
|
<a class="function" href="#SpotifyClient.ReorderPlaylistItems">ReorderPlaylistItems</a>
|
|
458
464
|
</li>
|
|
@@ -474,6 +480,9 @@
|
|
|
474
480
|
<li>
|
|
475
481
|
<a class="function" href="#SpotifyClient.SaveTrackFavorites">SaveTrackFavorites</a>
|
|
476
482
|
</li>
|
|
483
|
+
<li>
|
|
484
|
+
<a class="function" href="#SpotifyClient.SaveUserFavorites">SaveUserFavorites</a>
|
|
485
|
+
</li>
|
|
477
486
|
<li>
|
|
478
487
|
<a class="function" href="#SpotifyClient.Search">Search</a>
|
|
479
488
|
</li>
|
|
@@ -530,7 +539,7 @@
|
|
|
530
539
|
|
|
531
540
|
<footer class="footertext">
|
|
532
541
|
spotifywebapipython</br>
|
|
533
|
-
Version 1.0.
|
|
542
|
+
Version 1.0.261</br>
|
|
534
543
|
<a href="https://developer.spotify.com/documentation/web-api" target="_blank">
|
|
535
544
|
<img src="../spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
|
|
536
545
|
A Spotify Web Api Client
|
|
@@ -1361,6 +1370,10 @@ and the response contains error information.</li>
|
|
|
1361
1370
|
<li><strong>SpotifyApiError:</strong> If the method fails for any other reason.</li>
|
|
1362
1371
|
</ul>
|
|
1363
1372
|
|
|
1373
|
+
<p>All specified items are added to the playlist, even if any of the items already exist
|
|
1374
|
+
in the playlist. You must check for duplicates prior to adding items if you want to
|
|
1375
|
+
prevent duplicate items in the list.</p>
|
|
1376
|
+
|
|
1364
1377
|
<p><details>
|
|
1365
1378
|
<summary>Sample Code</summary></p>
|
|
1366
1379
|
|
|
@@ -1572,8 +1585,8 @@ upload the image after the playlist details are updated.</p>
|
|
|
1572
1585
|
<h6 id="arguments">Arguments:</h6>
|
|
1573
1586
|
|
|
1574
1587
|
<ul>
|
|
1575
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
1576
|
-
Maximum:
|
|
1588
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the albums. <br />
|
|
1589
|
+
Maximum: 40 IDs. <br />
|
|
1577
1590
|
Example: <code>6vc9OTcyd3hyzabCmsdnwE,2noRn2Aes5aoNVsU6iWThc</code>
|
|
1578
1591
|
If null, the currently playing album uri id value is used.</li>
|
|
1579
1592
|
</ul>
|
|
@@ -1667,7 +1680,7 @@ and the response contains error information.</li>
|
|
|
1667
1680
|
|
|
1668
1681
|
<ul>
|
|
1669
1682
|
<li><strong>ids (str):</strong> A comma-separated list of Spotify artist ID's to check. <br />
|
|
1670
|
-
Maximum:
|
|
1683
|
+
Maximum: 40 ID's. <br />
|
|
1671
1684
|
Example: <code>2CIMQHirSU0MQqyYHq0eOx,1IQ2e1buppatiN1bxUVkrk</code> <br />
|
|
1672
1685
|
If null, the currently playing artist uri id value is used.</li>
|
|
1673
1686
|
</ul>
|
|
@@ -1765,8 +1778,8 @@ and the response contains error information.</li>
|
|
|
1765
1778
|
<h6 id="arguments">Arguments:</h6>
|
|
1766
1779
|
|
|
1767
1780
|
<ul>
|
|
1768
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
1769
|
-
Maximum:
|
|
1781
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the audiobooks. <br />
|
|
1782
|
+
Maximum: 40 IDs. <br />
|
|
1770
1783
|
Example: <code>74aydHJKgYz3AIq3jjBSv1,4nfQ1hBJWjD0Jq9sK3YRW8,3PFyizE2tGCSRLusl2Qizf</code>
|
|
1771
1784
|
If null, the currently playing audiobook uri id value is used.</li>
|
|
1772
1785
|
</ul>
|
|
@@ -1860,8 +1873,8 @@ and the response contains error information.</li>
|
|
|
1860
1873
|
<h6 id="arguments">Arguments:</h6>
|
|
1861
1874
|
|
|
1862
1875
|
<ul>
|
|
1863
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
1864
|
-
Maximum:
|
|
1876
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the episodes. <br />
|
|
1877
|
+
Maximum: 40 IDs. <br />
|
|
1865
1878
|
Example: <code>1kWUud3vY5ij5r62zxpTRy,2takcwOaAZWiXQijPHIx7B</code>
|
|
1866
1879
|
If null, the currently playing episode uri id value is used.</li>
|
|
1867
1880
|
</ul>
|
|
@@ -1950,7 +1963,7 @@ and the response contains error information.</li>
|
|
|
1950
1963
|
<div class="attr function">
|
|
1951
1964
|
|
|
1952
1965
|
<span class="def">def</span>
|
|
1953
|
-
<span class="name">CheckPlaylistFollowers</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">playlistId</span><span class="p">:</span> <span class="nb">str</span>, </span><span class="param"><span class="n">userIds</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="nb">dict</span>:</span></span>
|
|
1966
|
+
<span class="name">CheckPlaylistFollowers</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">playlistId</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>, </span><span class="param"><span class="n">userIds</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="nb">dict</span>:</span></span>
|
|
1954
1967
|
|
|
1955
1968
|
|
|
1956
1969
|
</div>
|
|
@@ -1961,12 +1974,11 @@ and the response contains error information.</li>
|
|
|
1961
1974
|
<h6 id="arguments">Arguments:</h6>
|
|
1962
1975
|
|
|
1963
1976
|
<ul>
|
|
1964
|
-
<li><strong>playlistId (str):</strong>
|
|
1965
|
-
|
|
1966
|
-
<
|
|
1967
|
-
|
|
1968
|
-
|
|
1969
|
-
Example: <code>1kWUud3vY5ij5r62zxpTRy,2takcwOaAZWiXQijPHIx7B</code> </li>
|
|
1977
|
+
<li><strong>playlistId (str):</strong> A comma-separated list of Spotify playlist IDs. <br />
|
|
1978
|
+
A maximum of 40 IDs can be sent in one request.
|
|
1979
|
+
Example: <code>3cEYpjA9oz9GiPac4AsH4n</code>
|
|
1980
|
+
If null, the currently playing playlist uri id value is used.</li>
|
|
1981
|
+
<li><strong>userIds (str):</strong> DEPRECATED - no longer used, but left here to maintain compatibility.</li>
|
|
1970
1982
|
</ul>
|
|
1971
1983
|
|
|
1972
1984
|
<h6 id="returns">Returns:</h6>
|
|
@@ -2053,8 +2065,8 @@ generate a <code>400 Bad Request</code> error.</p>
|
|
|
2053
2065
|
<h6 id="arguments">Arguments:</h6>
|
|
2054
2066
|
|
|
2055
2067
|
<ul>
|
|
2056
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
2057
|
-
Maximum:
|
|
2068
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the shows. <br />
|
|
2069
|
+
Maximum: 40 IDs. <br />
|
|
2058
2070
|
Example: <code>1kWUud3vY5ij5r62zxpTRy,2takcwOaAZWiXQijPHIx7B</code>
|
|
2059
2071
|
If null, the currently playing show uri id value is used.</li>
|
|
2060
2072
|
</ul>
|
|
@@ -2148,8 +2160,8 @@ and the response contains error information.</li>
|
|
|
2148
2160
|
<h6 id="arguments">Arguments:</h6>
|
|
2149
2161
|
|
|
2150
2162
|
<ul>
|
|
2151
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
2152
|
-
Maximum:
|
|
2163
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the tracks. <br />
|
|
2164
|
+
Maximum: 40 IDs. <br />
|
|
2153
2165
|
Example: <code>1kWUud3vY5ij5r62zxpTRy,2takcwOaAZWiXQijPHIx7B</code>
|
|
2154
2166
|
If null, the currently playing track uri id value is used.</li>
|
|
2155
2167
|
</ul>
|
|
@@ -2220,6 +2232,101 @@ and the response contains error information.</li>
|
|
|
2220
2232
|
</code></pre>
|
|
2221
2233
|
</div>
|
|
2222
2234
|
|
|
2235
|
+
<p></details></p>
|
|
2236
|
+
</div>
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
</div>
|
|
2240
|
+
<div id="SpotifyClient.CheckUserFavorites" class="classattr">
|
|
2241
|
+
<div class="attr function">
|
|
2242
|
+
|
|
2243
|
+
<span class="def">def</span>
|
|
2244
|
+
<span class="name">CheckUserFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">uris</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="nb">dict</span>:</span></span>
|
|
2245
|
+
|
|
2246
|
+
|
|
2247
|
+
</div>
|
|
2248
|
+
<a class="headerlink" href="#SpotifyClient.CheckUserFavorites"></a>
|
|
2249
|
+
|
|
2250
|
+
<div class="docstring"><p>Check if one or more items are already saved in the current user's library.
|
|
2251
|
+
Accepts Spotify URIs for tracks, albums, episodes, shows, audiobooks, artists, users, and playlists.</p>
|
|
2252
|
+
|
|
2253
|
+
<p>This method requires the <code>user-library-read</code>, <code>user-follow-read</code>, and <code>playlist-read-private</code> scopes.</p>
|
|
2254
|
+
|
|
2255
|
+
<h6 id="arguments">Arguments:</h6>
|
|
2256
|
+
|
|
2257
|
+
<ul>
|
|
2258
|
+
<li><strong>uris (str):</strong> A comma-separated list of the Spotify URIs for the items. <br />
|
|
2259
|
+
Maximum: 40 URIs. <br />
|
|
2260
|
+
Example: <code>spotify:artist:6APm8EjxOHSYM5B4i3vT3q,spotify:album:6vc9OTcyd3hyzabCmsdnwE,spotify:track:1kWUud3vY5ij5r62zxpTRy</code>
|
|
2261
|
+
If null, the currently playing item uri value is used.</li>
|
|
2262
|
+
</ul>
|
|
2263
|
+
|
|
2264
|
+
<h6 id="returns">Returns:</h6>
|
|
2265
|
+
|
|
2266
|
+
<blockquote>
|
|
2267
|
+
<p>A dictionary of the uris, along with a boolean status for each that indicates
|
|
2268
|
+
if the item is saved (True) in the users 'Your Library' or not (False).</p>
|
|
2269
|
+
</blockquote>
|
|
2270
|
+
|
|
2271
|
+
<h6 id="raises">Raises:</h6>
|
|
2272
|
+
|
|
2273
|
+
<ul>
|
|
2274
|
+
<li><strong>SpotifyWebApiError:</strong> If the Spotify Web API request was for a non-authorization service
|
|
2275
|
+
and the response contains error information.</li>
|
|
2276
|
+
<li><strong>SpotifyApiError:</strong> If the method fails for any other reason.</li>
|
|
2277
|
+
</ul>
|
|
2278
|
+
|
|
2279
|
+
<p><details>
|
|
2280
|
+
<summary>Sample Code</summary></p>
|
|
2281
|
+
|
|
2282
|
+
<div class="pdoc-code codehilite">
|
|
2283
|
+
<pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">spotifywebapipython</span><span class="w"> </span><span class="kn">import</span> <span class="o">*</span>
|
|
2284
|
+
<span class="kn">from</span><span class="w"> </span><span class="nn">spotifywebapipython.models</span><span class="w"> </span><span class="kn">import</span> <span class="o">*</span>
|
|
2285
|
+
|
|
2286
|
+
<span class="k">try</span><span class="p">:</span>
|
|
2287
|
+
|
|
2288
|
+
<span class="c1"># this sample requires an authorization token, as it requires security scope to accesses user data.</span>
|
|
2289
|
+
|
|
2290
|
+
<span class="n">CLIENT_ID</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'your_client_id'</span>
|
|
2291
|
+
<span class="n">SPOTIFY_SCOPES</span><span class="p">:</span><span class="nb">list</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'user-read-email'</span><span class="p">,</span><span class="s1">'user-library-read'</span><span class="p">,</span><span class="s1">'user-follow-read'</span><span class="p">,</span><span class="s1">'playlist-read-private'</span><span class="p">]</span>
|
|
2292
|
+
|
|
2293
|
+
<span class="c1"># create new spotify client instance.</span>
|
|
2294
|
+
<span class="n">spotify</span><span class="p">:</span><span class="n">SpotifyClient</span> <span class="o">=</span> <span class="n">SpotifyClient</span><span class="p">()</span>
|
|
2295
|
+
|
|
2296
|
+
<span class="c1"># generate a spotify authorization code with PKCE access token (with scope, private and public data use).</span>
|
|
2297
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">SetAuthTokenAuthorizationCodePKCE</span><span class="p">(</span><span class="n">CLIENT_ID</span><span class="p">,</span> <span class="n">SPOTIFY_SCOPES</span><span class="p">)</span>
|
|
2298
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Auth Token:</span><span class="se">\n</span><span class="s1"> Type="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1"> Scope="</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">AuthToken</span><span class="o">.</span><span class="n">AuthorizationType</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">AuthToken</span><span class="o">.</span><span class="n">Scope</span><span class="p">)))</span>
|
|
2299
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">User:</span><span class="se">\n</span><span class="s1"> DisplayName="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1"> EMail="</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">UserProfile</span><span class="o">.</span><span class="n">DisplayName</span><span class="p">,</span> <span class="n">spotify</span><span class="o">.</span><span class="n">UserProfile</span><span class="o">.</span><span class="n">EMail</span><span class="p">))</span>
|
|
2300
|
+
|
|
2301
|
+
<span class="c1"># check if one or more items is already saved in the current Spotify user's 'Your Library'.</span>
|
|
2302
|
+
<span class="n">ids</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'spotify:artist:6APm8EjxOHSYM5B4i3vT3q,spotify:album:6vc9OTcyd3hyzabCmsdnwE,spotify:track:1kWUud3vY5ij5r62zxpTRy'</span>
|
|
2303
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Checking if items are saved by the current user: </span><span class="se">\n</span><span class="s1">- </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">ids</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">','</span><span class="p">,</span><span class="s1">'</span><span class="se">\n</span><span class="s1">- '</span><span class="p">))</span>
|
|
2304
|
+
<span class="n">result</span><span class="p">:</span><span class="nb">dict</span> <span class="o">=</span> <span class="n">spotify</span><span class="o">.</span><span class="n">CheckUserFavorites</span><span class="p">(</span><span class="n">ids</span><span class="p">)</span>
|
|
2305
|
+
|
|
2306
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Results:'</span><span class="p">)</span>
|
|
2307
|
+
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">result</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
|
|
2308
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'- </span><span class="si">%s</span><span class="s1"> = </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">result</span><span class="p">[</span><span class="n">key</span><span class="p">]))</span>
|
|
2309
|
+
|
|
2310
|
+
<span class="c1"># check if nowplaying item is saved in the current Spotify user's 'Your Library'.</span>
|
|
2311
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Checking if nowplaying item is saved by the current user ...'</span><span class="p">)</span>
|
|
2312
|
+
<span class="n">result</span><span class="p">:</span><span class="nb">dict</span> <span class="o">=</span> <span class="n">spotify</span><span class="o">.</span><span class="n">CheckUserFavorites</span><span class="p">()</span>
|
|
2313
|
+
|
|
2314
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Results:'</span><span class="p">)</span>
|
|
2315
|
+
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">result</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
|
|
2316
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'- </span><span class="si">%s</span><span class="s1"> = </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">result</span><span class="p">[</span><span class="n">key</span><span class="p">]))</span>
|
|
2317
|
+
|
|
2318
|
+
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
|
|
2319
|
+
|
|
2320
|
+
<span class="nb">print</span><span class="p">(</span><span class="s2">"** Exception: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
|
|
2321
|
+
|
|
2322
|
+
<span class="k">finally</span><span class="p">:</span>
|
|
2323
|
+
|
|
2324
|
+
<span class="c1"># shut down zeroconf directory browser and dispose of all resources.</span>
|
|
2325
|
+
<span class="k">if</span> <span class="p">(</span><span class="n">spotify</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">):</span>
|
|
2326
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">Dispose</span><span class="p">()</span>
|
|
2327
|
+
</code></pre>
|
|
2328
|
+
</div>
|
|
2329
|
+
|
|
2223
2330
|
<p></details></p>
|
|
2224
2331
|
</div>
|
|
2225
2332
|
|
|
@@ -2421,21 +2528,20 @@ and the response contains error information.</li>
|
|
|
2421
2528
|
<div class="attr function">
|
|
2422
2529
|
|
|
2423
2530
|
<span class="def">def</span>
|
|
2424
|
-
<span class="name">CreatePlaylist</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">userId</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">public</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>,</span><span class="param"> <span class="n">collaborative</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>,</span><span class="param"> <span class="n">imagePath</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="n"><a href="models/playlist.html#Playlist">spotifywebapipython.models.playlist.Playlist</a></span>:</span></span>
|
|
2531
|
+
<span class="name">CreatePlaylist</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">userId</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">public</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>,</span><span class="param"> <span class="n">collaborative</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>,</span><span class="param"> <span class="n">imagePath</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="n"><a href="models/playlist.html#Playlist">spotifywebapipython.models.playlist.Playlist</a></span>:</span></span>
|
|
2425
2532
|
|
|
2426
2533
|
|
|
2427
2534
|
</div>
|
|
2428
2535
|
<a class="headerlink" href="#SpotifyClient.CreatePlaylist"></a>
|
|
2429
2536
|
|
|
2430
|
-
<div class="docstring"><p>Create an empty playlist for
|
|
2537
|
+
<div class="docstring"><p>Create an empty playlist for the current Spotify user. </p>
|
|
2431
2538
|
|
|
2432
2539
|
<p>This method requires the <code>playlist-modify-public</code> and <code>playlist-modify-private</code> scope.</p>
|
|
2433
2540
|
|
|
2434
2541
|
<h6 id="arguments">Arguments:</h6>
|
|
2435
2542
|
|
|
2436
2543
|
<ul>
|
|
2437
|
-
<li><strong>userId (str):</strong>
|
|
2438
|
-
Example: <code>32k99y2kg5lnn3mxhtmd2bpdkjfu</code></li>
|
|
2544
|
+
<li><strong>userId (str):</strong> DEPRECATED - no longer used, but left here to maintain compatibility.</li>
|
|
2439
2545
|
<li><strong>name (str):</strong> The name for the new playlist, for example "My Playlist". <br />
|
|
2440
2546
|
This name does not need to be unique; a user may have several playlists with
|
|
2441
2547
|
the same name.</li>
|
|
@@ -2561,7 +2667,7 @@ and the response contains error information.</li>
|
|
|
2561
2667
|
|
|
2562
2668
|
<ul>
|
|
2563
2669
|
<li><strong>ids (str):</strong> A comma-separated list of the Spotify artist IDs. <br />
|
|
2564
|
-
A maximum of
|
|
2670
|
+
A maximum of 40 IDs can be sent in one request.
|
|
2565
2671
|
Example: <code>2CIMQHirSU0MQqyYHq0eOx,1IQ2e1buppatiN1bxUVkrk</code>
|
|
2566
2672
|
If null, the currently playing track artist uri id value is used.</li>
|
|
2567
2673
|
</ul>
|
|
@@ -2649,12 +2755,11 @@ and the response contains error information.</li>
|
|
|
2649
2755
|
<h6 id="arguments">Arguments:</h6>
|
|
2650
2756
|
|
|
2651
2757
|
<ul>
|
|
2652
|
-
<li><strong>playlistId (str):</strong>
|
|
2758
|
+
<li><strong>playlistId (str):</strong> A comma-separated list of Spotify playlist IDs. <br />
|
|
2759
|
+
A maximum of 40 IDs can be sent in one request.
|
|
2653
2760
|
Example: <code>3cEYpjA9oz9GiPac4AsH4n</code>
|
|
2654
2761
|
If null, the currently playing playlist uri id value is used.</li>
|
|
2655
|
-
<li><strong>public (bool):</strong>
|
|
2656
|
-
will remain private. <br />
|
|
2657
|
-
Default is True. </li>
|
|
2762
|
+
<li><strong>public (bool):</strong> DEPRECATED - no longer used, but left here to maintain compatibility.</li>
|
|
2658
2763
|
</ul>
|
|
2659
2764
|
|
|
2660
2765
|
<h6 id="raises">Raises:</h6>
|
|
@@ -2742,7 +2847,7 @@ and the response contains error information.</li>
|
|
|
2742
2847
|
|
|
2743
2848
|
<ul>
|
|
2744
2849
|
<li><strong>ids (str):</strong> A comma-separated list of the Spotify user IDs. <br />
|
|
2745
|
-
A maximum of
|
|
2850
|
+
A maximum of 40 IDs can be sent in one request.
|
|
2746
2851
|
Example: <code>smedjan</code></li>
|
|
2747
2852
|
</ul>
|
|
2748
2853
|
|
|
@@ -3128,7 +3233,15 @@ and the response contains error information.</li>
|
|
|
3128
3233
|
</div>
|
|
3129
3234
|
<a class="headerlink" href="#SpotifyClient.GetAlbumNewReleases"></a>
|
|
3130
3235
|
|
|
3131
|
-
<div class="docstring"><p>
|
|
3236
|
+
<div class="docstring"><p><span class="deprecated">
|
|
3237
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
3238
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
3239
|
+
More information about the deprecated functionality can be found on the
|
|
3240
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
3241
|
+
page.
|
|
3242
|
+
</span> </p>
|
|
3243
|
+
|
|
3244
|
+
<p>Get a list of new album releases featured in Spotify (shown, for example, on a
|
|
3132
3245
|
Spotify player's "Browse" tab).</p>
|
|
3133
3246
|
|
|
3134
3247
|
<h6 id="arguments">Arguments:</h6>
|
|
@@ -3288,7 +3401,15 @@ and the response contains error information.</li>
|
|
|
3288
3401
|
</div>
|
|
3289
3402
|
<a class="headerlink" href="#SpotifyClient.GetAlbums"></a>
|
|
3290
3403
|
|
|
3291
|
-
<div class="docstring"><p
|
|
3404
|
+
<div class="docstring"><p><span class="deprecated">
|
|
3405
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
3406
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
3407
|
+
More information about the deprecated functionality can be found on the
|
|
3408
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
3409
|
+
page.
|
|
3410
|
+
</span> </p>
|
|
3411
|
+
|
|
3412
|
+
<p>Get Spotify catalog information for multiple albums.</p>
|
|
3292
3413
|
|
|
3293
3414
|
<h6 id="arguments">Arguments:</h6>
|
|
3294
3415
|
|
|
@@ -4031,7 +4152,15 @@ and the response contains error information.</li>
|
|
|
4031
4152
|
</div>
|
|
4032
4153
|
<a class="headerlink" href="#SpotifyClient.GetArtists"></a>
|
|
4033
4154
|
|
|
4034
|
-
<div class="docstring"><p
|
|
4155
|
+
<div class="docstring"><p><span class="deprecated">
|
|
4156
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
4157
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
4158
|
+
More information about the deprecated functionality can be found on the
|
|
4159
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
4160
|
+
page.
|
|
4161
|
+
</span> </p>
|
|
4162
|
+
|
|
4163
|
+
<p>Get Spotify catalog information for several artists based on their Spotify IDs.</p>
|
|
4035
4164
|
|
|
4036
4165
|
<h6 id="arguments">Arguments:</h6>
|
|
4037
4166
|
|
|
@@ -4280,7 +4409,15 @@ and the response contains error information.</li>
|
|
|
4280
4409
|
</div>
|
|
4281
4410
|
<a class="headerlink" href="#SpotifyClient.GetArtistTopTracks"></a>
|
|
4282
4411
|
|
|
4283
|
-
<div class="docstring"><p
|
|
4412
|
+
<div class="docstring"><p><span class="deprecated">
|
|
4413
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
4414
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
4415
|
+
More information about the deprecated functionality can be found on the
|
|
4416
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
4417
|
+
page.
|
|
4418
|
+
</span> </p>
|
|
4419
|
+
|
|
4420
|
+
<p>Get Spotify catalog information about an artist's top tracks by country.</p>
|
|
4284
4421
|
|
|
4285
4422
|
<h6 id="arguments">Arguments:</h6>
|
|
4286
4423
|
|
|
@@ -4914,7 +5051,15 @@ and the response contains error information.</li>
|
|
|
4914
5051
|
</div>
|
|
4915
5052
|
<a class="headerlink" href="#SpotifyClient.GetAudiobooks"></a>
|
|
4916
5053
|
|
|
4917
|
-
<div class="docstring"><p
|
|
5054
|
+
<div class="docstring"><p><span class="deprecated">
|
|
5055
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
5056
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
5057
|
+
More information about the deprecated functionality can be found on the
|
|
5058
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
5059
|
+
page.
|
|
5060
|
+
</span> </p>
|
|
5061
|
+
|
|
5062
|
+
<p>Get Spotify catalog information for several audiobooks based on their Spotify IDs.</p>
|
|
4918
5063
|
|
|
4919
5064
|
<h6 id="arguments">Arguments:</h6>
|
|
4920
5065
|
|
|
@@ -5011,7 +5156,15 @@ and the response contains error information.</li>
|
|
|
5011
5156
|
</div>
|
|
5012
5157
|
<a class="headerlink" href="#SpotifyClient.GetBrowseCategory"></a>
|
|
5013
5158
|
|
|
5014
|
-
<div class="docstring"><p
|
|
5159
|
+
<div class="docstring"><p><span class="deprecated">
|
|
5160
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
5161
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
5162
|
+
More information about the deprecated functionality can be found on the
|
|
5163
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
5164
|
+
page.
|
|
5165
|
+
</span> </p>
|
|
5166
|
+
|
|
5167
|
+
<p>Get a single category used to tag items in Spotify.</p>
|
|
5015
5168
|
|
|
5016
5169
|
<h6 id="arguments">Arguments:</h6>
|
|
5017
5170
|
|
|
@@ -5119,7 +5272,15 @@ the spotify web api request. This results in better performance.</p>
|
|
|
5119
5272
|
</div>
|
|
5120
5273
|
<a class="headerlink" href="#SpotifyClient.GetBrowseCategorys"></a>
|
|
5121
5274
|
|
|
5122
|
-
<div class="docstring"><p
|
|
5275
|
+
<div class="docstring"><p><span class="deprecated">
|
|
5276
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
5277
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
5278
|
+
More information about the deprecated functionality can be found on the
|
|
5279
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
5280
|
+
page.
|
|
5281
|
+
</span> </p>
|
|
5282
|
+
|
|
5283
|
+
<p>Get categories used to tag items in Spotify.</p>
|
|
5123
5284
|
|
|
5124
5285
|
<h6 id="arguments">Arguments:</h6>
|
|
5125
5286
|
|
|
@@ -5765,7 +5926,15 @@ and the response contains error information.</li>
|
|
|
5765
5926
|
</div>
|
|
5766
5927
|
<a class="headerlink" href="#SpotifyClient.GetChapters"></a>
|
|
5767
5928
|
|
|
5768
|
-
<div class="docstring"><p
|
|
5929
|
+
<div class="docstring"><p><span class="deprecated">
|
|
5930
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
5931
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
5932
|
+
More information about the deprecated functionality can be found on the
|
|
5933
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
5934
|
+
page.
|
|
5935
|
+
</span> </p>
|
|
5936
|
+
|
|
5937
|
+
<p>Get Spotify catalog information for several chapters based on their Spotify IDs.</p>
|
|
5769
5938
|
|
|
5770
5939
|
<h6 id="arguments">Arguments:</h6>
|
|
5771
5940
|
|
|
@@ -6315,7 +6484,15 @@ and the response contains error information.</li>
|
|
|
6315
6484
|
</div>
|
|
6316
6485
|
<a class="headerlink" href="#SpotifyClient.GetEpisodes"></a>
|
|
6317
6486
|
|
|
6318
|
-
<div class="docstring"><p
|
|
6487
|
+
<div class="docstring"><p><span class="deprecated">
|
|
6488
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
6489
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
6490
|
+
More information about the deprecated functionality can be found on the
|
|
6491
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
6492
|
+
page.
|
|
6493
|
+
</span> </p>
|
|
6494
|
+
|
|
6495
|
+
<p>Get Spotify catalog information for several episodes based on their Spotify IDs.</p>
|
|
6319
6496
|
|
|
6320
6497
|
<h6 id="arguments">Arguments:</h6>
|
|
6321
6498
|
|
|
@@ -7026,7 +7203,15 @@ and the response contains error information.</li>
|
|
|
7026
7203
|
</div>
|
|
7027
7204
|
<a class="headerlink" href="#SpotifyClient.GetMarkets"></a>
|
|
7028
7205
|
|
|
7029
|
-
<div class="docstring"><p
|
|
7206
|
+
<div class="docstring"><p><span class="deprecated">
|
|
7207
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
7208
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
7209
|
+
More information about the deprecated functionality can be found on the
|
|
7210
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
7211
|
+
page.
|
|
7212
|
+
</span> </p>
|
|
7213
|
+
|
|
7214
|
+
<p>Get the list of markets (country codes) where Spotify is available.</p>
|
|
7030
7215
|
|
|
7031
7216
|
<h6 id="arguments">Arguments:</h6>
|
|
7032
7217
|
|
|
@@ -7670,7 +7855,7 @@ If nowplaying context is not a show episode.</li>
|
|
|
7670
7855
|
<div class="attr function">
|
|
7671
7856
|
|
|
7672
7857
|
<span class="def">def</span>
|
|
7673
|
-
<span class="name">GetPlayerNowPlayingUri</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">additionalTypes</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="nb">str</span>:</span></span>
|
|
7858
|
+
<span class="name">GetPlayerNowPlayingUri</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">additionalTypes</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>, </span><span class="param"><span class="n">checkSpecificType</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span></span><span class="return-annotation">) -> <span class="nb">str</span>:</span></span>
|
|
7674
7859
|
|
|
7675
7860
|
|
|
7676
7861
|
</div>
|
|
@@ -7685,6 +7870,8 @@ playing; otherwise, null is returned.</p>
|
|
|
7685
7870
|
<li><strong>additionalTypes (str):</strong> An item type that your client supports besides the default track type. <br />
|
|
7686
7871
|
Valid types are: <code>track</code> and <code>episode</code>. <br />
|
|
7687
7872
|
Specify <code>episode</code> to get podcast track information. </li>
|
|
7873
|
+
<li><strong>checkSpecificType (bool):</strong> If true, the currently playing type MUST match the specified additional type value;
|
|
7874
|
+
otherwise, it will return any uri that is currently playing.</li>
|
|
7688
7875
|
</ul>
|
|
7689
7876
|
|
|
7690
7877
|
<h6 id="raises">Raises:</h6>
|
|
@@ -8791,7 +8978,15 @@ and the response contains error information.</li>
|
|
|
8791
8978
|
</div>
|
|
8792
8979
|
<a class="headerlink" href="#SpotifyClient.GetPlaylistsForUser"></a>
|
|
8793
8980
|
|
|
8794
|
-
<div class="docstring"><p
|
|
8981
|
+
<div class="docstring"><p><span class="deprecated">
|
|
8982
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
8983
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
8984
|
+
More information about the deprecated functionality can be found on the
|
|
8985
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
8986
|
+
page.
|
|
8987
|
+
</span> </p>
|
|
8988
|
+
|
|
8989
|
+
<p>Get a list of the playlists owned or followed by a Spotify user.</p>
|
|
8795
8990
|
|
|
8796
8991
|
<p>This method requires the <code>playlist-read-private</code> and <code>playlist-read-collaborative</code> scope.</p>
|
|
8797
8992
|
|
|
@@ -9522,7 +9717,15 @@ only return podcast shows in the results if desired.</p>
|
|
|
9522
9717
|
</div>
|
|
9523
9718
|
<a class="headerlink" href="#SpotifyClient.GetShows"></a>
|
|
9524
9719
|
|
|
9525
|
-
<div class="docstring"><p
|
|
9720
|
+
<div class="docstring"><p><span class="deprecated">
|
|
9721
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
9722
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
9723
|
+
More information about the deprecated functionality can be found on the
|
|
9724
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
9725
|
+
page.
|
|
9726
|
+
</span> </p>
|
|
9727
|
+
|
|
9728
|
+
<p>Get Spotify catalog information for several shows based on their Spotify IDs.</p>
|
|
9526
9729
|
|
|
9527
9730
|
<h6 id="arguments">Arguments:</h6>
|
|
9528
9731
|
|
|
@@ -10323,7 +10526,15 @@ and the response contains error information.</li>
|
|
|
10323
10526
|
</div>
|
|
10324
10527
|
<a class="headerlink" href="#SpotifyClient.GetTracks"></a>
|
|
10325
10528
|
|
|
10326
|
-
<div class="docstring"><p
|
|
10529
|
+
<div class="docstring"><p><span class="deprecated">
|
|
10530
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
10531
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
10532
|
+
More information about the deprecated functionality can be found on the
|
|
10533
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
10534
|
+
page.
|
|
10535
|
+
</span> </p>
|
|
10536
|
+
|
|
10537
|
+
<p>Get Spotify catalog information for multiple tracks based on their Spotify IDs.</p>
|
|
10327
10538
|
|
|
10328
10539
|
<h6 id="arguments">Arguments:</h6>
|
|
10329
10540
|
|
|
@@ -10918,7 +11129,15 @@ the spotify web api request. This results in better performance.</p>
|
|
|
10918
11129
|
</div>
|
|
10919
11130
|
<a class="headerlink" href="#SpotifyClient.GetUsersPublicProfile"></a>
|
|
10920
11131
|
|
|
10921
|
-
<div class="docstring"><p
|
|
11132
|
+
<div class="docstring"><p><span class="deprecated">
|
|
11133
|
+
DEPRECATED - api endpoint no longer supported by Spotify as of 2026/02/11 for unauthorized Spotify Developer Applications.
|
|
11134
|
+
The api endpoint IS still supported by Spotify for authorized Spotify Developer Applications.
|
|
11135
|
+
More information about the deprecated functionality can be found on the
|
|
11136
|
+
<a href="https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security" target="_blank">Spotify Developer Forum Blog</a>
|
|
11137
|
+
page.
|
|
11138
|
+
</span> </p>
|
|
11139
|
+
|
|
11140
|
+
<p>Get public profile information about a Spotify user.</p>
|
|
10922
11141
|
|
|
10923
11142
|
<h6 id="arguments">Arguments:</h6>
|
|
10924
11143
|
|
|
@@ -13189,8 +13408,8 @@ don't stop playback on it, then it and the target device will both be playing!</
|
|
|
13189
13408
|
<h6 id="arguments">Arguments:</h6>
|
|
13190
13409
|
|
|
13191
13410
|
<ul>
|
|
13192
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
13193
|
-
Maximum:
|
|
13411
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the albums. <br />
|
|
13412
|
+
Maximum: 40 IDs. <br />
|
|
13194
13413
|
Example: <code>6vc9OTcyd3hyzabCmsdnwE,382ObEPsp2rxGrnsizN5TX</code>
|
|
13195
13414
|
If null, the currently playing track album uri id value is used.</li>
|
|
13196
13415
|
</ul>
|
|
@@ -13282,8 +13501,8 @@ in the Spotify music catalog.</p>
|
|
|
13282
13501
|
<h6 id="arguments">Arguments:</h6>
|
|
13283
13502
|
|
|
13284
13503
|
<ul>
|
|
13285
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
13286
|
-
Maximum:
|
|
13504
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the audiobooks. <br />
|
|
13505
|
+
Maximum: 40 IDs. <br />
|
|
13287
13506
|
Example: <code>3PFyizE2tGCSRLusl2Qizf,7iHfbu1YPACw6oZPAFJtqe</code>
|
|
13288
13507
|
If null, the currently playing audiobook uri id value is used.</li>
|
|
13289
13508
|
</ul>
|
|
@@ -13375,8 +13594,8 @@ in the Spotify music catalog.</p>
|
|
|
13375
13594
|
<h6 id="arguments">Arguments:</h6>
|
|
13376
13595
|
|
|
13377
13596
|
<ul>
|
|
13378
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
13379
|
-
Maximum:
|
|
13597
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the episodes. <br />
|
|
13598
|
+
Maximum: 40 IDs. <br />
|
|
13380
13599
|
Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code>
|
|
13381
13600
|
If null, the currently playing episode uri id value is used.</li>
|
|
13382
13601
|
</ul>
|
|
@@ -13591,6 +13810,8 @@ and the response contains error information.</li>
|
|
|
13591
13810
|
<p>The <code>snapshotId</code> argument value will be returned if no items were removed; otherwise, a
|
|
13592
13811
|
new snapshot id value will be returned.</p>
|
|
13593
13812
|
|
|
13813
|
+
<p>If the playlist contains duplicate items, then all of the item instances will be removed.</p>
|
|
13814
|
+
|
|
13594
13815
|
<p><details>
|
|
13595
13816
|
<summary>Sample Code</summary></p>
|
|
13596
13817
|
|
|
@@ -13678,8 +13899,8 @@ new snapshot id value will be returned.</p>
|
|
|
13678
13899
|
<h6 id="arguments">Arguments:</h6>
|
|
13679
13900
|
|
|
13680
13901
|
<ul>
|
|
13681
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
13682
|
-
Maximum:
|
|
13902
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the shows. <br />
|
|
13903
|
+
Maximum: 40 IDs. <br />
|
|
13683
13904
|
Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code>
|
|
13684
13905
|
If null, the currently playing show uri id value is used.</li>
|
|
13685
13906
|
</ul>
|
|
@@ -13771,8 +13992,8 @@ in the Spotify music catalog.</p>
|
|
|
13771
13992
|
<h6 id="arguments">Arguments:</h6>
|
|
13772
13993
|
|
|
13773
13994
|
<ul>
|
|
13774
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
13775
|
-
Maximum:
|
|
13995
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the tracks. <br />
|
|
13996
|
+
Maximum: 40 IDs. <br />
|
|
13776
13997
|
Example: <code>1kWUud3vY5ij5r62zxpTRy,4eoYKv2kDwJS7gRGh5q6SK</code>
|
|
13777
13998
|
If null, the currently playing track uri id value is used.</li>
|
|
13778
13999
|
</ul>
|
|
@@ -13840,6 +14061,102 @@ in the Spotify music catalog.</p>
|
|
|
13840
14061
|
</code></pre>
|
|
13841
14062
|
</div>
|
|
13842
14063
|
|
|
14064
|
+
<p></details></p>
|
|
14065
|
+
</div>
|
|
14066
|
+
|
|
14067
|
+
|
|
14068
|
+
</div>
|
|
14069
|
+
<div id="SpotifyClient.RemoveUserFavorites" class="classattr">
|
|
14070
|
+
<div class="attr function">
|
|
14071
|
+
|
|
14072
|
+
<span class="def">def</span>
|
|
14073
|
+
<span class="name">RemoveUserFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">uris</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
14074
|
+
|
|
14075
|
+
|
|
14076
|
+
</div>
|
|
14077
|
+
<a class="headerlink" href="#SpotifyClient.RemoveUserFavorites"></a>
|
|
14078
|
+
|
|
14079
|
+
<div class="docstring"><p>Remove one or more items from the current user's library. <br />
|
|
14080
|
+
Accepts Spotify URIs for tracks, albums, episodes, shows, audiobooks, users, and playlists.</p>
|
|
14081
|
+
|
|
14082
|
+
<p>This method requires the <code>user-library-modify</code>, <code>user-follow-modify</code>, and <code>playlist-modify-public</code> scopes.</p>
|
|
14083
|
+
|
|
14084
|
+
<h6 id="arguments">Arguments:</h6>
|
|
14085
|
+
|
|
14086
|
+
<ul>
|
|
14087
|
+
<li><strong>uris (str):</strong> A comma-separated list of the Spotify URIs for the items. <br />
|
|
14088
|
+
Maximum: 40 URIs. <br />
|
|
14089
|
+
Example: <code>spotify:artist:6APm8EjxOHSYM5B4i3vT3q,spotify:album:6vc9OTcyd3hyzabCmsdnwE,spotify:track:1kWUud3vY5ij5r62zxpTRy</code>
|
|
14090
|
+
If null, the currently playing item uri value is used.</li>
|
|
14091
|
+
</ul>
|
|
14092
|
+
|
|
14093
|
+
<h6 id="raises">Raises:</h6>
|
|
14094
|
+
|
|
14095
|
+
<ul>
|
|
14096
|
+
<li><strong>SpotifyWebApiError:</strong> If the Spotify Web API request was for a non-authorization service
|
|
14097
|
+
and the response contains error information.</li>
|
|
14098
|
+
<li><strong>SpotifyApiError:</strong> If the method fails for any other reason.</li>
|
|
14099
|
+
</ul>
|
|
14100
|
+
|
|
14101
|
+
<p>No error will be raised if an item uri in the list does not exist in the
|
|
14102
|
+
user's 'Your Library'.</p>
|
|
14103
|
+
|
|
14104
|
+
<p>An SpotifyWebApiError will be raised if a specified item uri does not exist
|
|
14105
|
+
in the Spotify music catalog.</p>
|
|
14106
|
+
|
|
14107
|
+
<p><details>
|
|
14108
|
+
<summary>Sample Code</summary></p>
|
|
14109
|
+
|
|
14110
|
+
<div class="pdoc-code codehilite">
|
|
14111
|
+
<pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">spotifywebapipython</span><span class="w"> </span><span class="kn">import</span> <span class="o">*</span>
|
|
14112
|
+
<span class="kn">from</span><span class="w"> </span><span class="nn">spotifywebapipython.models</span><span class="w"> </span><span class="kn">import</span> <span class="o">*</span>
|
|
14113
|
+
|
|
14114
|
+
<span class="k">try</span><span class="p">:</span>
|
|
14115
|
+
|
|
14116
|
+
<span class="c1"># this sample requires an authorization token, as it requires security scope to accesses user data.</span>
|
|
14117
|
+
|
|
14118
|
+
<span class="n">CLIENT_ID</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'your_client_id'</span>
|
|
14119
|
+
<span class="n">SPOTIFY_SCOPES</span><span class="p">:</span><span class="nb">list</span> <span class="o">=</span> \
|
|
14120
|
+
<span class="p">[</span>
|
|
14121
|
+
<span class="s1">'playlist-modify-public'</span><span class="p">,</span>
|
|
14122
|
+
<span class="s1">'user-library-modify'</span><span class="p">,</span>
|
|
14123
|
+
<span class="s1">'user-follow-modify'</span><span class="p">,</span>
|
|
14124
|
+
<span class="s1">'user-read-email'</span><span class="p">,</span>
|
|
14125
|
+
<span class="p">]</span>
|
|
14126
|
+
|
|
14127
|
+
<span class="c1"># create new spotify client instance.</span>
|
|
14128
|
+
<span class="n">spotify</span><span class="p">:</span><span class="n">SpotifyClient</span> <span class="o">=</span> <span class="n">SpotifyClient</span><span class="p">()</span>
|
|
14129
|
+
|
|
14130
|
+
<span class="c1"># generate a spotify authorization code with PKCE access token (with scope, private and public data use).</span>
|
|
14131
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">SetAuthTokenAuthorizationCodePKCE</span><span class="p">(</span><span class="n">CLIENT_ID</span><span class="p">,</span> <span class="n">SPOTIFY_SCOPES</span><span class="p">)</span>
|
|
14132
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Auth Token:</span><span class="se">\n</span><span class="s1"> Type="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1"> Scope="</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">AuthToken</span><span class="o">.</span><span class="n">AuthorizationType</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">AuthToken</span><span class="o">.</span><span class="n">Scope</span><span class="p">)))</span>
|
|
14133
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">User:</span><span class="se">\n</span><span class="s1"> DisplayName="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1"> EMail="</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">UserProfile</span><span class="o">.</span><span class="n">DisplayName</span><span class="p">,</span> <span class="n">spotify</span><span class="o">.</span><span class="n">UserProfile</span><span class="o">.</span><span class="n">EMail</span><span class="p">))</span>
|
|
14134
|
+
|
|
14135
|
+
<span class="c1"># remove one or more items from the current user's 'Your Library'.</span>
|
|
14136
|
+
<span class="n">ids</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'spotify:artist:6APm8EjxOHSYM5B4i3vT3q,spotify:album:6vc9OTcyd3hyzabCmsdnwE,spotify:track:1kWUud3vY5ij5r62zxpTRy'</span>
|
|
14137
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Removing saved item(s) from the current users library: </span><span class="se">\n</span><span class="s1">- </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">ids</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">','</span><span class="p">,</span><span class="s1">'</span><span class="se">\n</span><span class="s1">- '</span><span class="p">))</span>
|
|
14138
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">RemoveUserFavorites</span><span class="p">(</span><span class="n">ids</span><span class="p">)</span>
|
|
14139
|
+
|
|
14140
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Success - item(s) were removed'</span><span class="p">)</span>
|
|
14141
|
+
|
|
14142
|
+
<span class="c1"># remove nowplaying item from the current user's 'Your Library'.</span>
|
|
14143
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Removing nowplaying item from the current users library'</span><span class="p">)</span>
|
|
14144
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">RemoveUserFavorites</span><span class="p">()</span>
|
|
14145
|
+
|
|
14146
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Success - item(s) were removed'</span><span class="p">)</span>
|
|
14147
|
+
|
|
14148
|
+
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
|
|
14149
|
+
|
|
14150
|
+
<span class="nb">print</span><span class="p">(</span><span class="s2">"** Exception: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
|
|
14151
|
+
|
|
14152
|
+
<span class="k">finally</span><span class="p">:</span>
|
|
14153
|
+
|
|
14154
|
+
<span class="c1"># shut down zeroconf directory browser and dispose of all resources.</span>
|
|
14155
|
+
<span class="k">if</span> <span class="p">(</span><span class="n">spotify</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">):</span>
|
|
14156
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">Dispose</span><span class="p">()</span>
|
|
14157
|
+
</code></pre>
|
|
14158
|
+
</div>
|
|
14159
|
+
|
|
13843
14160
|
<p></details></p>
|
|
13844
14161
|
</div>
|
|
13845
14162
|
|
|
@@ -14086,8 +14403,8 @@ and the response contains error information.</li>
|
|
|
14086
14403
|
<h6 id="arguments">Arguments:</h6>
|
|
14087
14404
|
|
|
14088
14405
|
<ul>
|
|
14089
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
14090
|
-
Maximum:
|
|
14406
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the albums. <br />
|
|
14407
|
+
Maximum: 40 IDs. <br />
|
|
14091
14408
|
Example: <code>6vc9OTcyd3hyzabCmsdnwE,382ObEPsp2rxGrnsizN5TX,2noRn2Aes5aoNVsU6iWThc</code>
|
|
14092
14409
|
If null, the currently playing track album uri id value is used.</li>
|
|
14093
14410
|
</ul>
|
|
@@ -14179,8 +14496,8 @@ in the Spotify music catalog.</p>
|
|
|
14179
14496
|
<h6 id="arguments">Arguments:</h6>
|
|
14180
14497
|
|
|
14181
14498
|
<ul>
|
|
14182
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
14183
|
-
Maximum:
|
|
14499
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the audiobooks. <br />
|
|
14500
|
+
Maximum: 40 IDs. <br />
|
|
14184
14501
|
Example: <code>3PFyizE2tGCSRLusl2Qizf,7iHfbu1YPACw6oZPAFJtqe</code>
|
|
14185
14502
|
If null, the currently playing audiobook uri id value is used.</li>
|
|
14186
14503
|
</ul>
|
|
@@ -14272,8 +14589,8 @@ in the Spotify music catalog.</p>
|
|
|
14272
14589
|
<h6 id="arguments">Arguments:</h6>
|
|
14273
14590
|
|
|
14274
14591
|
<ul>
|
|
14275
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
14276
|
-
Maximum:
|
|
14592
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the episodes. <br />
|
|
14593
|
+
Maximum: 40 IDs. <br />
|
|
14277
14594
|
Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code>
|
|
14278
14595
|
If null, the currently playing episode uri id value is used.</li>
|
|
14279
14596
|
</ul>
|
|
@@ -14365,8 +14682,8 @@ in the Spotify music catalog.</p>
|
|
|
14365
14682
|
<h6 id="arguments">Arguments:</h6>
|
|
14366
14683
|
|
|
14367
14684
|
<ul>
|
|
14368
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
14369
|
-
Maximum:
|
|
14685
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the shows. <br />
|
|
14686
|
+
Maximum: 40 IDs. <br />
|
|
14370
14687
|
Example: <code>6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk</code>
|
|
14371
14688
|
If null, the currently playing show uri id value is used.</li>
|
|
14372
14689
|
</ul>
|
|
@@ -14458,8 +14775,8 @@ in the Spotify music catalog.</p>
|
|
|
14458
14775
|
<h6 id="arguments">Arguments:</h6>
|
|
14459
14776
|
|
|
14460
14777
|
<ul>
|
|
14461
|
-
<li><strong>ids (str):</strong> A comma-separated list of the Spotify
|
|
14462
|
-
Maximum:
|
|
14778
|
+
<li><strong>ids (str):</strong> A comma-separated list of the Spotify ID's (or URI's) for the tracks. <br />
|
|
14779
|
+
Maximum: 40 IDs. <br />
|
|
14463
14780
|
Example: <code>6vc9OTcyd3hyzabCmsdnwE,382ObEPsp2rxGrnsizN5TX,2noRn2Aes5aoNVsU6iWThc</code>
|
|
14464
14781
|
If null, the currently playing track uri id value is used.</li>
|
|
14465
14782
|
</ul>
|
|
@@ -14527,6 +14844,100 @@ in the Spotify music catalog.</p>
|
|
|
14527
14844
|
</code></pre>
|
|
14528
14845
|
</div>
|
|
14529
14846
|
|
|
14847
|
+
<p></details></p>
|
|
14848
|
+
</div>
|
|
14849
|
+
|
|
14850
|
+
|
|
14851
|
+
</div>
|
|
14852
|
+
<div id="SpotifyClient.SaveUserFavorites" class="classattr">
|
|
14853
|
+
<div class="attr function">
|
|
14854
|
+
|
|
14855
|
+
<span class="def">def</span>
|
|
14856
|
+
<span class="name">SaveUserFavorites</span><span class="signature pdoc-code condensed">(<span class="param"><span class="bp">self</span>, </span><span class="param"><span class="n">uris</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
14857
|
+
|
|
14858
|
+
|
|
14859
|
+
</div>
|
|
14860
|
+
<a class="headerlink" href="#SpotifyClient.SaveUserFavorites"></a>
|
|
14861
|
+
|
|
14862
|
+
<div class="docstring"><p>Add one or more items to the current user's library.
|
|
14863
|
+
Accepts Spotify URIs for tracks, albums, episodes, shows, audiobooks, users, and playlists.</p>
|
|
14864
|
+
|
|
14865
|
+
<p>This method requires the <code>user-library-modify</code>, <code>user-follow-modify</code>, and <code>playlist-modify-public</code> scopes.</p>
|
|
14866
|
+
|
|
14867
|
+
<h6 id="arguments">Arguments:</h6>
|
|
14868
|
+
|
|
14869
|
+
<ul>
|
|
14870
|
+
<li><strong>uris (str):</strong> A comma-separated list of the Spotify URIs for the items. <br />
|
|
14871
|
+
Maximum: 40 URIs. <br />
|
|
14872
|
+
Example: <code>spotify:artist:6APm8EjxOHSYM5B4i3vT3q,spotify:album:6vc9OTcyd3hyzabCmsdnwE,spotify:track:1kWUud3vY5ij5r62zxpTRy</code>
|
|
14873
|
+
If null, the currently playing item uri value is used.</li>
|
|
14874
|
+
</ul>
|
|
14875
|
+
|
|
14876
|
+
<h6 id="raises">Raises:</h6>
|
|
14877
|
+
|
|
14878
|
+
<ul>
|
|
14879
|
+
<li><strong>SpotifyWebApiError:</strong> If the Spotify Web API request was for a non-authorization service
|
|
14880
|
+
and the response contains error information.</li>
|
|
14881
|
+
<li><strong>SpotifyApiError:</strong> If the method fails for any other reason.</li>
|
|
14882
|
+
</ul>
|
|
14883
|
+
|
|
14884
|
+
<p>No error will be raised if an item uri in the list already exists in the
|
|
14885
|
+
user's 'Your Library'.</p>
|
|
14886
|
+
|
|
14887
|
+
<p>An SpotifyWebApiError will be raised if a specified item uri does not exist
|
|
14888
|
+
in the Spotify music catalog.</p>
|
|
14889
|
+
|
|
14890
|
+
<p><details>
|
|
14891
|
+
<summary>Sample Code</summary></p>
|
|
14892
|
+
|
|
14893
|
+
<div class="pdoc-code codehilite">
|
|
14894
|
+
<pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">spotifywebapipython</span><span class="w"> </span><span class="kn">import</span> <span class="o">*</span>
|
|
14895
|
+
<span class="kn">from</span><span class="w"> </span><span class="nn">spotifywebapipython.models</span><span class="w"> </span><span class="kn">import</span> <span class="o">*</span>
|
|
14896
|
+
|
|
14897
|
+
<span class="k">try</span><span class="p">:</span>
|
|
14898
|
+
|
|
14899
|
+
<span class="c1"># this sample requires an authorization token, as it requires security scope to accesses user data.</span>
|
|
14900
|
+
|
|
14901
|
+
<span class="n">CLIENT_ID</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'your_client_id'</span>
|
|
14902
|
+
<span class="n">SPOTIFY_SCOPES</span><span class="p">:</span><span class="nb">list</span> <span class="o">=</span> \
|
|
14903
|
+
<span class="p">[</span>
|
|
14904
|
+
<span class="s1">'user-library-modify'</span><span class="p">,</span>
|
|
14905
|
+
<span class="s1">'user-read-email'</span><span class="p">,</span>
|
|
14906
|
+
<span class="p">]</span>
|
|
14907
|
+
|
|
14908
|
+
<span class="c1"># create new spotify client instance.</span>
|
|
14909
|
+
<span class="n">spotify</span><span class="p">:</span><span class="n">SpotifyClient</span> <span class="o">=</span> <span class="n">SpotifyClient</span><span class="p">()</span>
|
|
14910
|
+
|
|
14911
|
+
<span class="c1"># generate a spotify authorization code with PKCE access token (with scope, private and public data use).</span>
|
|
14912
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">SetAuthTokenAuthorizationCodePKCE</span><span class="p">(</span><span class="n">CLIENT_ID</span><span class="p">,</span> <span class="n">SPOTIFY_SCOPES</span><span class="p">)</span>
|
|
14913
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Auth Token:</span><span class="se">\n</span><span class="s1"> Type="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1"> Scope="</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">AuthToken</span><span class="o">.</span><span class="n">AuthorizationType</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">AuthToken</span><span class="o">.</span><span class="n">Scope</span><span class="p">)))</span>
|
|
14914
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">User:</span><span class="se">\n</span><span class="s1"> DisplayName="</span><span class="si">%s</span><span class="s1">"</span><span class="se">\n</span><span class="s1"> EMail="</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">spotify</span><span class="o">.</span><span class="n">UserProfile</span><span class="o">.</span><span class="n">DisplayName</span><span class="p">,</span> <span class="n">spotify</span><span class="o">.</span><span class="n">UserProfile</span><span class="o">.</span><span class="n">EMail</span><span class="p">))</span>
|
|
14915
|
+
|
|
14916
|
+
<span class="c1"># save one or more items to the current user's 'Your Library'.</span>
|
|
14917
|
+
<span class="n">ids</span><span class="p">:</span><span class="nb">str</span> <span class="o">=</span> <span class="s1">'spotify:artist:6APm8EjxOHSYM5B4i3vT3q,spotify:album:6vc9OTcyd3hyzabCmsdnwE,spotify:track:1kWUud3vY5ij5r62zxpTRy'</span>
|
|
14918
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Adding saved items(s) to the current users library: </span><span class="se">\n</span><span class="s1">- </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">ids</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">','</span><span class="p">,</span><span class="s1">'</span><span class="se">\n</span><span class="s1">- '</span><span class="p">))</span>
|
|
14919
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">SaveUserFavorites</span><span class="p">(</span><span class="n">ids</span><span class="p">)</span>
|
|
14920
|
+
|
|
14921
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Success - items(s) were added'</span><span class="p">)</span>
|
|
14922
|
+
|
|
14923
|
+
<span class="c1"># save nowplaying item to the current user's 'Your Library'.</span>
|
|
14924
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Saving nowplaying item to the current users library'</span><span class="p">)</span>
|
|
14925
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">SaveUserFavorites</span><span class="p">()</span>
|
|
14926
|
+
|
|
14927
|
+
<span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Success - items(s) were added'</span><span class="p">)</span>
|
|
14928
|
+
|
|
14929
|
+
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
|
|
14930
|
+
|
|
14931
|
+
<span class="nb">print</span><span class="p">(</span><span class="s2">"** Exception: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
|
|
14932
|
+
|
|
14933
|
+
<span class="k">finally</span><span class="p">:</span>
|
|
14934
|
+
|
|
14935
|
+
<span class="c1"># shut down zeroconf directory browser and dispose of all resources.</span>
|
|
14936
|
+
<span class="k">if</span> <span class="p">(</span><span class="n">spotify</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">):</span>
|
|
14937
|
+
<span class="n">spotify</span><span class="o">.</span><span class="n">Dispose</span><span class="p">()</span>
|
|
14938
|
+
</code></pre>
|
|
14939
|
+
</div>
|
|
14940
|
+
|
|
14530
14941
|
<p></details></p>
|
|
14531
14942
|
</div>
|
|
14532
14943
|
|
|
@@ -14580,7 +14991,7 @@ Allowed values: "audio"</li>
|
|
|
14580
14991
|
<li><strong>limitTotal (int):</strong> The maximum number of items to return for the request, per criteria type.
|
|
14581
14992
|
Paging is automatically used to retrieve all available items up to the
|
|
14582
14993
|
maximum number specified per type.
|
|
14583
|
-
Default:
|
|
14994
|
+
Default: 10</li>
|
|
14584
14995
|
</ul>
|
|
14585
14996
|
|
|
14586
14997
|
<h6 id="returns">Returns:</h6>
|
|
@@ -14682,7 +15093,7 @@ techniques for searching.</p>
|
|
|
14682
15093
|
<div class="attr function">
|
|
14683
15094
|
|
|
14684
15095
|
<span class="def">def</span>
|
|
14685
|
-
<span class="name">SearchAlbums</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">
|
|
15096
|
+
<span class="name">SearchAlbums</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">5</span>,</span><span class="param"> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>,</span><span class="param"> <span class="n">market</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">includeExternal</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="n"><a href="models/searchresponse.html#SearchResponse">spotifywebapipython.models.searchresponse.SearchResponse</a></span>:</span></span>
|
|
14686
15097
|
|
|
14687
15098
|
|
|
14688
15099
|
</div>
|
|
@@ -14881,7 +15292,7 @@ be returned with a search.</p>
|
|
|
14881
15292
|
<div class="attr function">
|
|
14882
15293
|
|
|
14883
15294
|
<span class="def">def</span>
|
|
14884
|
-
<span class="name">SearchArtists</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">
|
|
15295
|
+
<span class="name">SearchArtists</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">5</span>,</span><span class="param"> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>,</span><span class="param"> <span class="n">market</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">includeExternal</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="n"><a href="models/searchresponse.html#SearchResponse">spotifywebapipython.models.searchresponse.SearchResponse</a></span>:</span></span>
|
|
14885
15296
|
|
|
14886
15297
|
|
|
14887
15298
|
</div>
|
|
@@ -14905,7 +15316,7 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
|
|
|
14905
15316
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
14906
15317
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
14907
15318
|
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
14908
|
-
Default:
|
|
15319
|
+
Default: 5, Range: 1 to 10. <br />
|
|
14909
15320
|
See the <code>limitTotal</code> argument for automatic paging option. </li>
|
|
14910
15321
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
14911
15322
|
Use with limit to get the next set of items. <br />
|
|
@@ -15079,7 +15490,7 @@ be returned with a search.</p>
|
|
|
15079
15490
|
<div class="attr function">
|
|
15080
15491
|
|
|
15081
15492
|
<span class="def">def</span>
|
|
15082
|
-
<span class="name">SearchAudiobooks</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">
|
|
15493
|
+
<span class="name">SearchAudiobooks</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">5</span>,</span><span class="param"> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>,</span><span class="param"> <span class="n">market</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">includeExternal</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="n"><a href="models/searchresponse.html#SearchResponse">spotifywebapipython.models.searchresponse.SearchResponse</a></span>:</span></span>
|
|
15083
15494
|
|
|
15084
15495
|
|
|
15085
15496
|
</div>
|
|
@@ -15103,7 +15514,7 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
|
|
|
15103
15514
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
15104
15515
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
15105
15516
|
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
15106
|
-
Default:
|
|
15517
|
+
Default: 5, Range: 1 to 10. <br />
|
|
15107
15518
|
See the <code>limitTotal</code> argument for automatic paging option. </li>
|
|
15108
15519
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
15109
15520
|
Use with limit to get the next set of items. <br />
|
|
@@ -15293,7 +15704,7 @@ be returned with a search.</p>
|
|
|
15293
15704
|
<div class="attr function">
|
|
15294
15705
|
|
|
15295
15706
|
<span class="def">def</span>
|
|
15296
|
-
<span class="name">SearchEpisodes</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">
|
|
15707
|
+
<span class="name">SearchEpisodes</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">5</span>,</span><span class="param"> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>,</span><span class="param"> <span class="n">market</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">includeExternal</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="n"><a href="models/searchresponse.html#SearchResponse">spotifywebapipython.models.searchresponse.SearchResponse</a></span>:</span></span>
|
|
15297
15708
|
|
|
15298
15709
|
|
|
15299
15710
|
</div>
|
|
@@ -15317,7 +15728,7 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
|
|
|
15317
15728
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
15318
15729
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
15319
15730
|
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
15320
|
-
Default:
|
|
15731
|
+
Default: 5, Range: 1 to 10. <br />
|
|
15321
15732
|
See the <code>limitTotal</code> argument for automatic paging option. </li>
|
|
15322
15733
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
15323
15734
|
Use with limit to get the next set of items. <br />
|
|
@@ -15505,7 +15916,7 @@ be returned with a search.</p>
|
|
|
15505
15916
|
<div class="attr function">
|
|
15506
15917
|
|
|
15507
15918
|
<span class="def">def</span>
|
|
15508
|
-
<span class="name">SearchPlaylists</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">
|
|
15919
|
+
<span class="name">SearchPlaylists</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">5</span>,</span><span class="param"> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>,</span><span class="param"> <span class="n">market</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">includeExternal</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="n"><a href="models/searchresponse.html#SearchResponse">spotifywebapipython.models.searchresponse.SearchResponse</a></span>:</span></span>
|
|
15509
15920
|
|
|
15510
15921
|
|
|
15511
15922
|
</div>
|
|
@@ -15529,7 +15940,7 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
|
|
|
15529
15940
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
15530
15941
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
15531
15942
|
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
15532
|
-
Default:
|
|
15943
|
+
Default: 5, Range: 1 to 10. <br />
|
|
15533
15944
|
See the <code>limitTotal</code> argument for automatic paging option. </li>
|
|
15534
15945
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
15535
15946
|
Use with limit to get the next set of items. <br />
|
|
@@ -15717,7 +16128,7 @@ be returned with a search.</p>
|
|
|
15717
16128
|
<div class="attr function">
|
|
15718
16129
|
|
|
15719
16130
|
<span class="def">def</span>
|
|
15720
|
-
<span class="name">SearchShows</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">
|
|
16131
|
+
<span class="name">SearchShows</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">5</span>,</span><span class="param"> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>,</span><span class="param"> <span class="n">market</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">includeExternal</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="n"><a href="models/searchresponse.html#SearchResponse">spotifywebapipython.models.searchresponse.SearchResponse</a></span>:</span></span>
|
|
15721
16132
|
|
|
15722
16133
|
|
|
15723
16134
|
</div>
|
|
@@ -15741,7 +16152,7 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
|
|
|
15741
16152
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
15742
16153
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
15743
16154
|
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
15744
|
-
Default:
|
|
16155
|
+
Default: 5, Range: 1 to 10. <br />
|
|
15745
16156
|
See the <code>limitTotal</code> argument for automatic paging option. </li>
|
|
15746
16157
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
15747
16158
|
Use with limit to get the next set of items. <br />
|
|
@@ -15933,7 +16344,7 @@ be returned with a search.</p>
|
|
|
15933
16344
|
<div class="attr function">
|
|
15934
16345
|
|
|
15935
16346
|
<span class="def">def</span>
|
|
15936
|
-
<span class="name">SearchTracks</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">
|
|
16347
|
+
<span class="name">SearchTracks</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">criteria</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">5</span>,</span><span class="param"> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>,</span><span class="param"> <span class="n">market</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">includeExternal</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span></span><span class="return-annotation">) -> <span class="n"><a href="models/searchresponse.html#SearchResponse">spotifywebapipython.models.searchresponse.SearchResponse</a></span>:</span></span>
|
|
15937
16348
|
|
|
15938
16349
|
|
|
15939
16350
|
</div>
|
|
@@ -15957,7 +16368,7 @@ The upc, tag:new and tag:hipster filters can only be used while searching albums
|
|
|
15957
16368
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
15958
16369
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
15959
16370
|
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
15960
|
-
Default:
|
|
16371
|
+
Default: 5, Range: 1 to 10. <br />
|
|
15961
16372
|
See the <code>limitTotal</code> argument for automatic paging option. </li>
|
|
15962
16373
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
15963
16374
|
Use with limit to get the next set of items. <br />
|
|
@@ -16381,7 +16792,7 @@ token updates are passed on to the external provider.</p>
|
|
|
16381
16792
|
|
|
16382
16793
|
<ul>
|
|
16383
16794
|
<li><strong>ids (str):</strong> A comma-separated list of Spotify artist IDs. <br />
|
|
16384
|
-
A maximum of
|
|
16795
|
+
A maximum of 40 IDs can be sent in one request.
|
|
16385
16796
|
Example: <code>2CIMQHirSU0MQqyYHq0eOx,1IQ2e1buppatiN1bxUVkrk</code>
|
|
16386
16797
|
If null, the currently playing track artist uri id value is used.</li>
|
|
16387
16798
|
</ul>
|
|
@@ -16469,7 +16880,8 @@ and the response contains error information.</li>
|
|
|
16469
16880
|
<h6 id="arguments">Arguments:</h6>
|
|
16470
16881
|
|
|
16471
16882
|
<ul>
|
|
16472
|
-
<li><strong>playlistId (str):</strong>
|
|
16883
|
+
<li><strong>playlistId (str):</strong> A comma-separated list of Spotify playlist IDs. <br />
|
|
16884
|
+
A maximum of 40 IDs can be sent in one request.
|
|
16473
16885
|
Example: <code>3cEYpjA9oz9GiPac4AsH4n</code>
|
|
16474
16886
|
If null, the currently playing playlist uri id value is used.</li>
|
|
16475
16887
|
</ul>
|
|
@@ -16559,7 +16971,7 @@ and the response contains error information.</li>
|
|
|
16559
16971
|
|
|
16560
16972
|
<ul>
|
|
16561
16973
|
<li><strong>ids (str):</strong> A comma-separated list of Spotify user IDs. <br />
|
|
16562
|
-
A maximum of
|
|
16974
|
+
A maximum of 40 IDs can be sent in one request.
|
|
16563
16975
|
Example: <code>smedjan</code></li>
|
|
16564
16976
|
</ul>
|
|
16565
16977
|
|