spotifywebapiPython 1.0.76__py3-none-any.whl → 1.0.77__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.
Potentially problematic release.
This version of spotifywebapiPython might be problematic. Click here for more details.
- {spotifywebapiPython-1.0.76.dist-info → spotifywebapiPython-1.0.77.dist-info}/METADATA +1 -1
- {spotifywebapiPython-1.0.76.dist-info → spotifywebapiPython-1.0.77.dist-info}/RECORD +23 -23
- spotifywebapipython/const.py +1 -1
- spotifywebapipython/docs/__init__.html +13 -2
- spotifywebapipython/docs/index.html +2 -2
- spotifywebapipython/docs/search.js +1 -1
- spotifywebapipython/docs/spotifywebapiPython/const.html +3 -3
- spotifywebapipython/docs/spotifywebapiPython/saappmessages.html +2 -2
- 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 +109 -53
- spotifywebapipython/docs/spotifywebapiPython/spotifydiscovery.html +2 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifywebapiauthenticationerror.html +2 -2
- spotifywebapipython/docs/spotifywebapiPython/spotifywebapierror.html +2 -2
- spotifywebapipython/oauthcli/authclient.py +10 -11
- spotifywebapipython/spotifyclient.py +282 -150
- spotifywebapipython/zeroconfapi/blobbuilder.py +7 -12
- spotifywebapipython/zeroconfapi/zeroconfconnect.py +244 -43
- {spotifywebapiPython-1.0.76.dist-info → spotifywebapiPython-1.0.77.dist-info}/LICENSE +0 -0
- {spotifywebapiPython-1.0.76.dist-info → spotifywebapiPython-1.0.77.dist-info}/WHEEL +0 -0
- {spotifywebapiPython-1.0.76.dist-info → spotifywebapiPython-1.0.77.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.77" -->
|
|
13
13
|
<!-- pdoc module.modulename = "spotifywebapipython.spotifyclient" -->
|
|
14
14
|
<!-- pdoc module.is_package = "False" -->
|
|
15
15
|
<!-- pdoc root_module_name = "None" -->
|
|
@@ -452,7 +452,7 @@
|
|
|
452
452
|
|
|
453
453
|
<footer class="footertext">
|
|
454
454
|
spotifywebapiPython</br>
|
|
455
|
-
Version 1.0.
|
|
455
|
+
Version 1.0.77</br>
|
|
456
456
|
<a href="https://developer.spotify.com/documentation/web-api" target="_blank">
|
|
457
457
|
<img src="../spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
|
|
458
458
|
A Spotify Web Api Client
|
|
@@ -2389,7 +2389,7 @@ and the response contains error information.</li>
|
|
|
2389
2389
|
<div class="attr function">
|
|
2390
2390
|
|
|
2391
2391
|
<span class="def">def</span>
|
|
2392
|
-
<span class="name">GetAlbumFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">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/albumpagesaved.html#AlbumPageSaved">spotifywebapipython.models.albumpagesaved.AlbumPageSaved</a></span>:</span></span>
|
|
2392
|
+
<span class="name">GetAlbumFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">sortResult</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="n"><a href="models/albumpagesaved.html#AlbumPageSaved">spotifywebapipython.models.albumpagesaved.AlbumPageSaved</a></span>:</span></span>
|
|
2393
2393
|
|
|
2394
2394
|
|
|
2395
2395
|
</div>
|
|
@@ -2402,7 +2402,7 @@ and the response contains error information.</li>
|
|
|
2402
2402
|
<h6 id="arguments">Arguments:</h6>
|
|
2403
2403
|
|
|
2404
2404
|
<ul>
|
|
2405
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
2405
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
2406
2406
|
Default: 20, Range: 1 to 50. </li>
|
|
2407
2407
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
2408
2408
|
Use with limit to get the next set of items. <br />
|
|
@@ -2419,6 +2419,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
2419
2419
|
and paging is automatically used to retrieve all available items up to the
|
|
2420
2420
|
maximum number specified. <br />
|
|
2421
2421
|
Default: None (disabled)</li>
|
|
2422
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
2423
|
+
were returned in by the Spotify Web API. <br />
|
|
2424
|
+
Default: True</li>
|
|
2422
2425
|
</ul>
|
|
2423
2426
|
|
|
2424
2427
|
<h6 id="returns">Returns:</h6>
|
|
@@ -2540,7 +2543,7 @@ and the response contains error information.</li>
|
|
|
2540
2543
|
<div class="attr function">
|
|
2541
2544
|
|
|
2542
2545
|
<span class="def">def</span>
|
|
2543
|
-
<span class="name">GetAlbumNewReleases</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">country</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/albumpagesimplified.html#AlbumPageSimplified">spotifywebapipython.models.albumpagesimplified.AlbumPageSimplified</a></span>:</span></span>
|
|
2546
|
+
<span class="name">GetAlbumNewReleases</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">country</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="param"> <span class="n">sortResult</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="n"><a href="models/albumpagesimplified.html#AlbumPageSimplified">spotifywebapipython.models.albumpagesimplified.AlbumPageSimplified</a></span>:</span></span>
|
|
2544
2547
|
|
|
2545
2548
|
|
|
2546
2549
|
</div>
|
|
@@ -2552,7 +2555,7 @@ Spotify player's "Browse" tab).</p>
|
|
|
2552
2555
|
<h6 id="arguments">Arguments:</h6>
|
|
2553
2556
|
|
|
2554
2557
|
<ul>
|
|
2555
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
2558
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
2556
2559
|
Default: 20, Range: 1 to 50. </li>
|
|
2557
2560
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
2558
2561
|
Use with limit to get the next set of items. <br />
|
|
@@ -2566,6 +2569,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
2566
2569
|
and paging is automatically used to retrieve all available items up to the
|
|
2567
2570
|
maximum number specified. <br />
|
|
2568
2571
|
Default: None (disabled)</li>
|
|
2572
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
2573
|
+
were returned in by the Spotify Web API. <br />
|
|
2574
|
+
Default: True</li>
|
|
2569
2575
|
</ul>
|
|
2570
2576
|
|
|
2571
2577
|
<h6 id="returns">Returns:</h6>
|
|
@@ -2792,7 +2798,7 @@ and the response contains error information.</li>
|
|
|
2792
2798
|
<ul>
|
|
2793
2799
|
<li><strong>albumId (str):</strong> The Spotify ID of the album. <br />
|
|
2794
2800
|
Example: <code>6vc9OTcyd3hyzabCmsdnwE</code></li>
|
|
2795
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
2801
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
2796
2802
|
Default: 20, Range: 1 to 50. </li>
|
|
2797
2803
|
<li><strong>offset (int):</strong> The index of the first item to return; use with limit to get the next set of items. <br />
|
|
2798
2804
|
Default: 0 (the first item). </li>
|
|
@@ -3003,7 +3009,7 @@ and the response contains error information.</li>
|
|
|
3003
3009
|
<div class="attr function">
|
|
3004
3010
|
|
|
3005
3011
|
<span class="def">def</span>
|
|
3006
|
-
<span class="name">GetArtistAlbums</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">artistId</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">include_groups</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'album'</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">20</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">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/albumpagesimplified.html#AlbumPageSimplified">spotifywebapipython.models.albumpagesimplified.AlbumPageSimplified</a></span>:</span></span>
|
|
3012
|
+
<span class="name">GetArtistAlbums</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">artistId</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">include_groups</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'album'</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">20</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">sortResult</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="n"><a href="models/albumpagesimplified.html#AlbumPageSimplified">spotifywebapipython.models.albumpagesimplified.AlbumPageSimplified</a></span>:</span></span>
|
|
3007
3013
|
|
|
3008
3014
|
|
|
3009
3015
|
</div>
|
|
@@ -3020,7 +3026,7 @@ Example: <code>6APm8EjxOHSYM5B4i3vT3q</code></li>
|
|
|
3020
3026
|
If not supplied, all album types will be returned. <br />
|
|
3021
3027
|
Valid values are: <code>album</code>, <code>single</code>, <code>appears_on</code>, <code>compilation</code> <br />
|
|
3022
3028
|
Example: <code>single,appears_on</code></li>
|
|
3023
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
3029
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
3024
3030
|
Default: 20, Range: 1 to 50. </li>
|
|
3025
3031
|
<li><strong>offset (int):</strong> The index of the first item to return; use with limit to get the next set of items. <br />
|
|
3026
3032
|
Default: 0 (the first item). </li>
|
|
@@ -3036,6 +3042,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
3036
3042
|
and paging is automatically used to retrieve all available items up to the
|
|
3037
3043
|
maximum number specified. <br />
|
|
3038
3044
|
Default: None (disabled)</li>
|
|
3045
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
3046
|
+
were returned in by the Spotify Web API. <br />
|
|
3047
|
+
Default: True</li>
|
|
3039
3048
|
</ul>
|
|
3040
3049
|
|
|
3041
3050
|
<h6 id="returns">Returns:</h6>
|
|
@@ -3381,7 +3390,7 @@ and the response contains error information.</li>
|
|
|
3381
3390
|
<div class="attr function">
|
|
3382
3391
|
|
|
3383
3392
|
<span class="def">def</span>
|
|
3384
|
-
<span class="name">GetArtistsFollowed</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">after</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">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">20</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/artistpage.html#ArtistPage">spotifywebapipython.models.artistpage.ArtistPage</a></span>:</span></span>
|
|
3393
|
+
<span class="name">GetArtistsFollowed</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">after</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">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">20</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="param"> <span class="n">sortResult</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="n"><a href="models/artistpage.html#ArtistPage">spotifywebapipython.models.artistpage.ArtistPage</a></span>:</span></span>
|
|
3385
3394
|
|
|
3386
3395
|
|
|
3387
3396
|
</div>
|
|
@@ -3395,13 +3404,16 @@ and the response contains error information.</li>
|
|
|
3395
3404
|
<li><strong>after (str):</strong> The last artist ID retrieved from the previous request, or null for
|
|
3396
3405
|
the first request. <br />
|
|
3397
3406
|
Example: <code>6APm8EjxOHSYM5B4i3vT3q</code> </li>
|
|
3398
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
3407
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
3399
3408
|
Default: 20, Range: 1 to 50. </li>
|
|
3400
3409
|
<li><strong>limitTotal (int):</strong> The maximum number of items to return for the request. <br />
|
|
3401
3410
|
If specified, this argument overrides the limit and offset argument values
|
|
3402
3411
|
and paging is automatically used to retrieve all available items up to the
|
|
3403
3412
|
maximum number specified. <br />
|
|
3404
3413
|
Default: None (disabled)</li>
|
|
3414
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
3415
|
+
were returned in by the Spotify Web API. <br />
|
|
3416
|
+
Default: True</li>
|
|
3405
3417
|
</ul>
|
|
3406
3418
|
|
|
3407
3419
|
<h6 id="returns">Returns:</h6>
|
|
@@ -3744,7 +3756,7 @@ and the response contains error information.</li>
|
|
|
3744
3756
|
<ul>
|
|
3745
3757
|
<li><strong>audiobookId (str):</strong> The Spotify ID for the audiobook.
|
|
3746
3758
|
Example: <code>74aydHJKgYz3AIq3jjBSv1</code></li>
|
|
3747
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
3759
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
3748
3760
|
Default: 20, Range: 1 to 50. </li>
|
|
3749
3761
|
<li><strong>offset (int):</strong> The index of the first item to return; use with limit to get the next set of items. <br />
|
|
3750
3762
|
Default: 0 (the first item). </li>
|
|
@@ -3906,7 +3918,7 @@ and the response contains error information.</li>
|
|
|
3906
3918
|
<div class="attr function">
|
|
3907
3919
|
|
|
3908
3920
|
<span class="def">def</span>
|
|
3909
|
-
<span class="name">GetAudiobookFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">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/audiobookpagesimplified.html#AudiobookPageSimplified">spotifywebapipython.models.audiobookpagesimplified.AudiobookPageSimplified</a></span>:</span></span>
|
|
3921
|
+
<span class="name">GetAudiobookFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">sortResult</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="n"><a href="models/audiobookpagesimplified.html#AudiobookPageSimplified">spotifywebapipython.models.audiobookpagesimplified.AudiobookPageSimplified</a></span>:</span></span>
|
|
3910
3922
|
|
|
3911
3923
|
|
|
3912
3924
|
</div>
|
|
@@ -3919,7 +3931,7 @@ and the response contains error information.</li>
|
|
|
3919
3931
|
<h6 id="arguments">Arguments:</h6>
|
|
3920
3932
|
|
|
3921
3933
|
<ul>
|
|
3922
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
3934
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
3923
3935
|
Default: 20, Range: 1 to 50. </li>
|
|
3924
3936
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
3925
3937
|
Use with limit to get the next set of items. <br />
|
|
@@ -3929,6 +3941,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
3929
3941
|
and paging is automatically used to retrieve all available items up to the
|
|
3930
3942
|
maximum number specified. <br />
|
|
3931
3943
|
Default: None (disabled)</li>
|
|
3944
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
3945
|
+
were returned in by the Spotify Web API. <br />
|
|
3946
|
+
Default: True</li>
|
|
3932
3947
|
</ul>
|
|
3933
3948
|
|
|
3934
3949
|
<h6 id="returns">Returns:</h6>
|
|
@@ -4243,7 +4258,7 @@ the spotify web api request. This results in better performance.</p>
|
|
|
4243
4258
|
<div class="attr function">
|
|
4244
4259
|
|
|
4245
4260
|
<span class="def">def</span>
|
|
4246
|
-
<span class="name">GetBrowseCategorys</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">country</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">locale</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/categorypage.html#CategoryPage">spotifywebapipython.models.categorypage.CategoryPage</a></span>:</span></span>
|
|
4261
|
+
<span class="name">GetBrowseCategorys</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">country</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">locale</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="param"> <span class="n">sortResult</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="n"><a href="models/categorypage.html#CategoryPage">spotifywebapipython.models.categorypage.CategoryPage</a></span>:</span></span>
|
|
4247
4262
|
|
|
4248
4263
|
|
|
4249
4264
|
</div>
|
|
@@ -4254,7 +4269,7 @@ the spotify web api request. This results in better performance.</p>
|
|
|
4254
4269
|
<h6 id="arguments">Arguments:</h6>
|
|
4255
4270
|
|
|
4256
4271
|
<ul>
|
|
4257
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
4272
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
4258
4273
|
Default: 20, Range: 1 to 50. </li>
|
|
4259
4274
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
4260
4275
|
Use with limit to get the next set of items. <br />
|
|
@@ -4277,6 +4292,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
4277
4292
|
and paging is automatically used to retrieve all available items up to the
|
|
4278
4293
|
maximum number specified. <br />
|
|
4279
4294
|
Default: None (disabled)</li>
|
|
4295
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
4296
|
+
were returned in by the Spotify Web API. <br />
|
|
4297
|
+
Default: True</li>
|
|
4280
4298
|
</ul>
|
|
4281
4299
|
|
|
4282
4300
|
<h6 id="returns">Returns:</h6>
|
|
@@ -4499,7 +4517,7 @@ the spotify web api request. This results in better performance.</p>
|
|
|
4499
4517
|
<div class="attr function">
|
|
4500
4518
|
|
|
4501
4519
|
<span class="def">def</span>
|
|
4502
|
-
<span class="name">GetCategoryPlaylists</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">categoryId</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">20</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">country</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">Tuple</span><span class="p">[</span><span class="n"><a href="models/playlistpagesimplified.html#PlaylistPageSimplified">spotifywebapipython.models.playlistpagesimplified.PlaylistPageSimplified</a></span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span>:</span></span>
|
|
4520
|
+
<span class="name">GetCategoryPlaylists</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">categoryId</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">20</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">country</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="param"> <span class="n">sortResult</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="n">Tuple</span><span class="p">[</span><span class="n"><a href="models/playlistpagesimplified.html#PlaylistPageSimplified">spotifywebapipython.models.playlistpagesimplified.PlaylistPageSimplified</a></span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span>:</span></span>
|
|
4503
4521
|
|
|
4504
4522
|
|
|
4505
4523
|
</div>
|
|
@@ -4512,7 +4530,7 @@ the spotify web api request. This results in better performance.</p>
|
|
|
4512
4530
|
<ul>
|
|
4513
4531
|
<li><strong>categoryId (str):</strong> The Spotify category ID for the category. <br />
|
|
4514
4532
|
Example: <code>dinner</code></li>
|
|
4515
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
4533
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
4516
4534
|
Default: 20, Range: 1 to 50. </li>
|
|
4517
4535
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
4518
4536
|
Use with limit to get the next set of items. <br />
|
|
@@ -4526,6 +4544,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
4526
4544
|
and paging is automatically used to retrieve all available items up to the
|
|
4527
4545
|
maximum number specified. <br />
|
|
4528
4546
|
Default: None (disabled)</li>
|
|
4547
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
4548
|
+
were returned in by the Spotify Web API. <br />
|
|
4549
|
+
Default: True</li>
|
|
4529
4550
|
</ul>
|
|
4530
4551
|
|
|
4531
4552
|
<h6 id="returns">Returns:</h6>
|
|
@@ -4989,7 +5010,7 @@ and the response contains error information.</li>
|
|
|
4989
5010
|
<div class="attr function">
|
|
4990
5011
|
|
|
4991
5012
|
<span class="def">def</span>
|
|
4992
|
-
<span class="name">GetEpisodeFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">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/episodepagesaved.html#EpisodePageSaved">spotifywebapipython.models.episodepagesaved.EpisodePageSaved</a></span>:</span></span>
|
|
5013
|
+
<span class="name">GetEpisodeFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">sortResult</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="n"><a href="models/episodepagesaved.html#EpisodePageSaved">spotifywebapipython.models.episodepagesaved.EpisodePageSaved</a></span>:</span></span>
|
|
4993
5014
|
|
|
4994
5015
|
|
|
4995
5016
|
</div>
|
|
@@ -5002,7 +5023,7 @@ and the response contains error information.</li>
|
|
|
5002
5023
|
<h6 id="arguments">Arguments:</h6>
|
|
5003
5024
|
|
|
5004
5025
|
<ul>
|
|
5005
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
5026
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
5006
5027
|
Default: 20, Range: 1 to 50. </li>
|
|
5007
5028
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
5008
5029
|
Use with limit to get the next set of items. <br />
|
|
@@ -5012,6 +5033,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
5012
5033
|
and paging is automatically used to retrieve all available items up to the
|
|
5013
5034
|
maximum number specified. <br />
|
|
5014
5035
|
Default: None (disabled)</li>
|
|
5036
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
5037
|
+
were returned in by the Spotify Web API. <br />
|
|
5038
|
+
Default: True</li>
|
|
5015
5039
|
</ul>
|
|
5016
5040
|
|
|
5017
5041
|
<h6 id="returns">Returns:</h6>
|
|
@@ -5258,7 +5282,7 @@ and the response contains error information.</li>
|
|
|
5258
5282
|
<div class="attr function">
|
|
5259
5283
|
|
|
5260
5284
|
<span class="def">def</span>
|
|
5261
|
-
<span class="name">GetFeaturedPlaylists</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">country</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">locale</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">timestamp</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">Tuple</span><span class="p">[</span><span class="n"><a href="models/playlistpagesimplified.html#PlaylistPageSimplified">spotifywebapipython.models.playlistpagesimplified.PlaylistPageSimplified</a></span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span>:</span></span>
|
|
5285
|
+
<span class="name">GetFeaturedPlaylists</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">country</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">locale</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">timestamp</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="param"> <span class="n">sortResult</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="n">Tuple</span><span class="p">[</span><span class="n"><a href="models/playlistpagesimplified.html#PlaylistPageSimplified">spotifywebapipython.models.playlistpagesimplified.PlaylistPageSimplified</a></span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span>:</span></span>
|
|
5262
5286
|
|
|
5263
5287
|
|
|
5264
5288
|
</div>
|
|
@@ -5269,7 +5293,7 @@ and the response contains error information.</li>
|
|
|
5269
5293
|
<h6 id="arguments">Arguments:</h6>
|
|
5270
5294
|
|
|
5271
5295
|
<ul>
|
|
5272
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
5296
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
5273
5297
|
Default: 20, Range: 1 to 50. </li>
|
|
5274
5298
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
5275
5299
|
Use with limit to get the next set of items. <br />
|
|
@@ -5299,6 +5323,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
5299
5323
|
and paging is automatically used to retrieve all available items up to the
|
|
5300
5324
|
maximum number specified. <br />
|
|
5301
5325
|
Default: None (disabled)</li>
|
|
5326
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
5327
|
+
were returned in by the Spotify Web API. <br />
|
|
5328
|
+
Default: True</li>
|
|
5302
5329
|
</ul>
|
|
5303
5330
|
|
|
5304
5331
|
<h6 id="returns">Returns:</h6>
|
|
@@ -5957,7 +5984,7 @@ in better performance.</p>
|
|
|
5957
5984
|
<div class="attr function">
|
|
5958
5985
|
|
|
5959
5986
|
<span class="def">def</span>
|
|
5960
|
-
<span class="name">GetPlayerDevices</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">refresh</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">list</span><span class="p">[</span><span class="n"><a href="models/device.html#Device">spotifywebapipython.models.device.Device</a></span><span class="p">]</span>:</span></span>
|
|
5987
|
+
<span class="name">GetPlayerDevices</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">refresh</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">sortResult</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">list</span><span class="p">[</span><span class="n"><a href="models/device.html#Device">spotifywebapipython.models.device.Device</a></span><span class="p">]</span>:</span></span>
|
|
5961
5988
|
|
|
5962
5989
|
|
|
5963
5990
|
</div>
|
|
@@ -5974,6 +6001,9 @@ in better performance.</p>
|
|
|
5974
6001
|
<ul>
|
|
5975
6002
|
<li><strong>refresh (bool):</strong> True (default) to return real-time information from the spotify web api and
|
|
5976
6003
|
update the cache; otherwise, False to just return the cached value.</li>
|
|
6004
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
6005
|
+
were returned in by the Spotify Web API. <br />
|
|
6006
|
+
Default: True</li>
|
|
5977
6007
|
</ul>
|
|
5978
6008
|
|
|
5979
6009
|
<h6 id="returns">Returns:</h6>
|
|
@@ -6349,8 +6379,8 @@ Note: Currently doesn't support podcast episodes.</p>
|
|
|
6349
6379
|
<h6 id="arguments">Arguments:</h6>
|
|
6350
6380
|
|
|
6351
6381
|
<ul>
|
|
6352
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
6353
|
-
Default:
|
|
6382
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
6383
|
+
Default: 20, Range: 1 to 50. </li>
|
|
6354
6384
|
<li><strong>after (int):</strong> Returns all items after (but not including) this cursor position, which is
|
|
6355
6385
|
a Unix timestamp in milliseconds. <br />
|
|
6356
6386
|
If <code>after</code> is specified, <code>before</code> must not be specified. <br />
|
|
@@ -6717,7 +6747,7 @@ and the response contains error information.</li>
|
|
|
6717
6747
|
<ul>
|
|
6718
6748
|
<li><strong>playlistId (str):</strong> The Spotify ID of the playlist. <br />
|
|
6719
6749
|
Example: <code>5v5ETK9WFXAnGQ3MRubKuE</code></li>
|
|
6720
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
6750
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
6721
6751
|
Default: 50, Range: 1 to 50. </li>
|
|
6722
6752
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
6723
6753
|
Use with limit to get the next set of items. <br />
|
|
@@ -6882,7 +6912,7 @@ and the response contains error information.</li>
|
|
|
6882
6912
|
<div class="attr function">
|
|
6883
6913
|
|
|
6884
6914
|
<span class="def">def</span>
|
|
6885
|
-
<span class="name">GetPlaylistFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">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/playlistpagesimplified.html#PlaylistPageSimplified">spotifywebapipython.models.playlistpagesimplified.PlaylistPageSimplified</a></span>:</span></span>
|
|
6915
|
+
<span class="name">GetPlaylistFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">sortResult</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="n"><a href="models/playlistpagesimplified.html#PlaylistPageSimplified">spotifywebapipython.models.playlistpagesimplified.PlaylistPageSimplified</a></span>:</span></span>
|
|
6886
6916
|
|
|
6887
6917
|
|
|
6888
6918
|
</div>
|
|
@@ -6895,7 +6925,7 @@ and the response contains error information.</li>
|
|
|
6895
6925
|
<h6 id="arguments">Arguments:</h6>
|
|
6896
6926
|
|
|
6897
6927
|
<ul>
|
|
6898
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
6928
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
6899
6929
|
Default: 20, Range: 1 to 50. </li>
|
|
6900
6930
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
6901
6931
|
Use with limit to get the next set of items. <br />
|
|
@@ -6905,6 +6935,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
6905
6935
|
and paging is automatically used to retrieve all available items up to the
|
|
6906
6936
|
maximum number specified. <br />
|
|
6907
6937
|
Default: None (disabled)</li>
|
|
6938
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
6939
|
+
were returned in by the Spotify Web API. <br />
|
|
6940
|
+
Default: True</li>
|
|
6908
6941
|
</ul>
|
|
6909
6942
|
|
|
6910
6943
|
<h6 id="returns">Returns:</h6>
|
|
@@ -7041,7 +7074,7 @@ and the response contains error information.</li>
|
|
|
7041
7074
|
<div class="attr function">
|
|
7042
7075
|
|
|
7043
7076
|
<span class="def">def</span>
|
|
7044
|
-
<span class="name">GetPlaylistsForUser</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">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">20</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">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/playlistpagesimplified.html#PlaylistPageSimplified">spotifywebapipython.models.playlistpagesimplified.PlaylistPageSimplified</a></span>:</span></span>
|
|
7077
|
+
<span class="name">GetPlaylistsForUser</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">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">20</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">sortResult</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="n"><a href="models/playlistpagesimplified.html#PlaylistPageSimplified">spotifywebapipython.models.playlistpagesimplified.PlaylistPageSimplified</a></span>:</span></span>
|
|
7045
7078
|
|
|
7046
7079
|
|
|
7047
7080
|
</div>
|
|
@@ -7056,7 +7089,7 @@ and the response contains error information.</li>
|
|
|
7056
7089
|
<ul>
|
|
7057
7090
|
<li><strong>userId (str):</strong> The user's Spotify user ID. <br />
|
|
7058
7091
|
Example: <code>smedjan</code></li>
|
|
7059
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
7092
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
7060
7093
|
Default: 20, Range: 1 to 50. </li>
|
|
7061
7094
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
7062
7095
|
Use with limit to get the next set of items. <br />
|
|
@@ -7066,6 +7099,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
7066
7099
|
and paging is automatically used to retrieve all available items up to the
|
|
7067
7100
|
maximum number specified. <br />
|
|
7068
7101
|
Default: None (disabled)</li>
|
|
7102
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
7103
|
+
were returned in by the Spotify Web API. <br />
|
|
7104
|
+
Default: True</li>
|
|
7069
7105
|
</ul>
|
|
7070
7106
|
|
|
7071
7107
|
<h6 id="returns">Returns:</h6>
|
|
@@ -7332,7 +7368,7 @@ and the response contains error information.</li>
|
|
|
7332
7368
|
<ul>
|
|
7333
7369
|
<li><strong>showId (str):</strong> The Spotify ID for the show.
|
|
7334
7370
|
Example: <code>6kAsbP8pxwaU2kPibKTuHE</code></li>
|
|
7335
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
7371
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
7336
7372
|
Default: 20, Range: 1 to 50. </li>
|
|
7337
7373
|
<li><strong>offset (int):</strong> The index of the first item to return; use with limit to get the next set of items. <br />
|
|
7338
7374
|
Default: 0 (the first item). </li>
|
|
@@ -7494,7 +7530,7 @@ and the response contains error information.</li>
|
|
|
7494
7530
|
<div class="attr function">
|
|
7495
7531
|
|
|
7496
7532
|
<span class="def">def</span>
|
|
7497
|
-
<span class="name">GetShowFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">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/showpagesaved.html#ShowPageSaved">spotifywebapipython.models.showpagesaved.ShowPageSaved</a></span>:</span></span>
|
|
7533
|
+
<span class="name">GetShowFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">sortResult</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="n"><a href="models/showpagesaved.html#ShowPageSaved">spotifywebapipython.models.showpagesaved.ShowPageSaved</a></span>:</span></span>
|
|
7498
7534
|
|
|
7499
7535
|
|
|
7500
7536
|
</div>
|
|
@@ -7507,7 +7543,7 @@ and the response contains error information.</li>
|
|
|
7507
7543
|
<h6 id="arguments">Arguments:</h6>
|
|
7508
7544
|
|
|
7509
7545
|
<ul>
|
|
7510
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
7546
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
7511
7547
|
Default: 20, Range: 1 to 50. </li>
|
|
7512
7548
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
7513
7549
|
Use with limit to get the next set of items. <br />
|
|
@@ -7517,6 +7553,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
7517
7553
|
and paging is automatically used to retrieve all available items up to the
|
|
7518
7554
|
maximum number specified. <br />
|
|
7519
7555
|
Default: None (disabled)</li>
|
|
7556
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
7557
|
+
were returned in by the Spotify Web API. <br />
|
|
7558
|
+
Default: True</li>
|
|
7520
7559
|
</ul>
|
|
7521
7560
|
|
|
7522
7561
|
<h6 id="returns">Returns:</h6>
|
|
@@ -8012,7 +8051,7 @@ and the response contains error information.</li>
|
|
|
8012
8051
|
<div class="attr function">
|
|
8013
8052
|
|
|
8014
8053
|
<span class="def">def</span>
|
|
8015
|
-
<span class="name">GetTrackFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">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/trackpagesaved.html#TrackPageSaved">spotifywebapipython.models.trackpagesaved.TrackPageSaved</a></span>:</span></span>
|
|
8054
|
+
<span class="name">GetTrackFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</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">20</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">sortResult</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="n"><a href="models/trackpagesaved.html#TrackPageSaved">spotifywebapipython.models.trackpagesaved.TrackPageSaved</a></span>:</span></span>
|
|
8016
8055
|
|
|
8017
8056
|
|
|
8018
8057
|
</div>
|
|
@@ -8025,7 +8064,7 @@ and the response contains error information.</li>
|
|
|
8025
8064
|
<h6 id="arguments">Arguments:</h6>
|
|
8026
8065
|
|
|
8027
8066
|
<ul>
|
|
8028
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
8067
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
8029
8068
|
Default: 20, Range: 1 to 50. </li>
|
|
8030
8069
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
8031
8070
|
Use with limit to get the next set of items. <br />
|
|
@@ -8042,6 +8081,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
8042
8081
|
and paging is automatically used to retrieve all available items up to the
|
|
8043
8082
|
maximum number specified. <br />
|
|
8044
8083
|
Default: None (disabled)</li>
|
|
8084
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
8085
|
+
were returned in by the Spotify Web API. <br />
|
|
8086
|
+
Default: True</li>
|
|
8045
8087
|
</ul>
|
|
8046
8088
|
|
|
8047
8089
|
<h6 id="returns">Returns:</h6>
|
|
@@ -8768,7 +8810,7 @@ and the response contains error information.</li>
|
|
|
8768
8810
|
<div class="attr function">
|
|
8769
8811
|
|
|
8770
8812
|
<span class="def">def</span>
|
|
8771
|
-
<span class="name">GetUsersTopArtists</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">timeRange</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'medium_term'</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">20</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">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/artistpage.html#ArtistPage">spotifywebapipython.models.artistpage.ArtistPage</a></span>:</span></span>
|
|
8813
|
+
<span class="name">GetUsersTopArtists</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">timeRange</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'medium_term'</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">20</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">sortResult</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="n"><a href="models/artistpage.html#ArtistPage">spotifywebapipython.models.artistpage.ArtistPage</a></span>:</span></span>
|
|
8772
8814
|
|
|
8773
8815
|
|
|
8774
8816
|
</div>
|
|
@@ -8788,7 +8830,7 @@ Valid values: <br />
|
|
|
8788
8830
|
Default: <code>medium_term</code> <br />
|
|
8789
8831
|
Example: <code>long_term</code></li>
|
|
8790
8832
|
</ul></li>
|
|
8791
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
8833
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
8792
8834
|
Default: 20, Range: 1 to 50. </li>
|
|
8793
8835
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
8794
8836
|
Use with limit to get the next set of items. <br />
|
|
@@ -8798,6 +8840,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
8798
8840
|
and paging is automatically used to retrieve all available items up to the
|
|
8799
8841
|
maximum number specified. <br />
|
|
8800
8842
|
Default: None (disabled)</li>
|
|
8843
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
8844
|
+
were returned in by the Spotify Web API. <br />
|
|
8845
|
+
Default: True</li>
|
|
8801
8846
|
</ul>
|
|
8802
8847
|
|
|
8803
8848
|
<h6 id="returns">Returns:</h6>
|
|
@@ -8930,7 +8975,7 @@ and the response contains error information.</li>
|
|
|
8930
8975
|
<div class="attr function">
|
|
8931
8976
|
|
|
8932
8977
|
<span class="def">def</span>
|
|
8933
|
-
<span class="name">GetUsersTopTracks</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">timeRange</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'medium_term'</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">20</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">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/trackpage.html#TrackPage">spotifywebapipython.models.trackpage.TrackPage</a></span>:</span></span>
|
|
8978
|
+
<span class="name">GetUsersTopTracks</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">timeRange</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'medium_term'</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">20</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="kc">None</span>,</span><span class="param"> <span class="n">sortResult</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="n"><a href="models/trackpage.html#TrackPage">spotifywebapipython.models.trackpage.TrackPage</a></span>:</span></span>
|
|
8934
8979
|
|
|
8935
8980
|
|
|
8936
8981
|
</div>
|
|
@@ -8950,7 +8995,7 @@ Valid values: <br />
|
|
|
8950
8995
|
Default: <code>medium_term</code> <br />
|
|
8951
8996
|
Example: <code>long_term</code></li>
|
|
8952
8997
|
</ul></li>
|
|
8953
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
8998
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
8954
8999
|
Default: 20, Range: 1 to 50. </li>
|
|
8955
9000
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
8956
9001
|
Use with limit to get the next set of items. <br />
|
|
@@ -8960,6 +9005,9 @@ If specified, this argument overrides the limit and offset argument values
|
|
|
8960
9005
|
and paging is automatically used to retrieve all available items up to the
|
|
8961
9006
|
maximum number specified. <br />
|
|
8962
9007
|
Default: None (disabled)</li>
|
|
9008
|
+
<li><strong>sortResult (bool):</strong> True to sort the items by name; otherwise, False to leave the items in the same order they
|
|
9009
|
+
were returned in by the Spotify Web API. <br />
|
|
9010
|
+
Default: True</li>
|
|
8963
9011
|
</ul>
|
|
8964
9012
|
|
|
8965
9013
|
<h6 id="returns">Returns:</h6>
|
|
@@ -9463,7 +9511,7 @@ and the response contains error information.</li>
|
|
|
9463
9511
|
<div class="attr function">
|
|
9464
9512
|
|
|
9465
9513
|
<span class="def">def</span>
|
|
9466
|
-
<span class="name">PlayerMediaPlayTrackFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">deviceId</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">shuffle</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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span>,</span><span class="param"> <span class="n">resolveDeviceId</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="kc">None</span>:</span></span>
|
|
9514
|
+
<span class="name">PlayerMediaPlayTrackFavorites</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">deviceId</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">shuffle</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">delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.5</span>,</span><span class="param"> <span class="n">resolveDeviceId</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">limitTotal</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">200</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
9467
9515
|
|
|
9468
9516
|
|
|
9469
9517
|
</div>
|
|
@@ -9486,6 +9534,8 @@ another command is issued. <br />
|
|
|
9486
9534
|
Default is 0.50; value range is 0 - 10.</li>
|
|
9487
9535
|
<li><strong>resolveDeviceId (bool):</strong> True to resolve the supplied <code>deviceId</code> value; otherwise, False not resolve the <code>deviceId</code>
|
|
9488
9536
|
value as it has already been resolved.</li>
|
|
9537
|
+
<li><strong>limitTotal (int):</strong> The maximum number of items to retrieve from favorites. <br />
|
|
9538
|
+
Default: 200</li>
|
|
9489
9539
|
</ul>
|
|
9490
9540
|
|
|
9491
9541
|
<h6 id="raises">Raises:</h6>
|
|
@@ -11882,7 +11932,7 @@ The isrc and track filters can be used while searching tracks. <br />
|
|
|
11882
11932
|
The upc, tag:new and tag:hipster filters can only be used while searching albums.
|
|
11883
11933
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
11884
11934
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
11885
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
11935
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
11886
11936
|
Default: 20, Range: 1 to 50. </li>
|
|
11887
11937
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
11888
11938
|
Use with limit to get the next set of items. <br />
|
|
@@ -12068,7 +12118,7 @@ The isrc and track filters can be used while searching tracks. <br />
|
|
|
12068
12118
|
The upc, tag:new and tag:hipster filters can only be used while searching albums.
|
|
12069
12119
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
12070
12120
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
12071
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
12121
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
12072
12122
|
Default: 20, Range: 1 to 50. </li>
|
|
12073
12123
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
12074
12124
|
Use with limit to get the next set of items. <br />
|
|
@@ -12253,7 +12303,7 @@ The isrc and track filters can be used while searching tracks. <br />
|
|
|
12253
12303
|
The upc, tag:new and tag:hipster filters can only be used while searching albums.
|
|
12254
12304
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
12255
12305
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
12256
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
12306
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
12257
12307
|
Default: 20, Range: 1 to 50. </li>
|
|
12258
12308
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
12259
12309
|
Use with limit to get the next set of items. <br />
|
|
@@ -12454,7 +12504,7 @@ The isrc and track filters can be used while searching tracks. <br />
|
|
|
12454
12504
|
The upc, tag:new and tag:hipster filters can only be used while searching albums.
|
|
12455
12505
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
12456
12506
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
12457
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
12507
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
12458
12508
|
Default: 20, Range: 1 to 50. </li>
|
|
12459
12509
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
12460
12510
|
Use with limit to get the next set of items. <br />
|
|
@@ -12653,7 +12703,7 @@ The isrc and track filters can be used while searching tracks. <br />
|
|
|
12653
12703
|
The upc, tag:new and tag:hipster filters can only be used while searching albums.
|
|
12654
12704
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
12655
12705
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
12656
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
12706
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
12657
12707
|
Default: 20, Range: 1 to 50. </li>
|
|
12658
12708
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
12659
12709
|
Use with limit to get the next set of items. <br />
|
|
@@ -12852,7 +12902,7 @@ The isrc and track filters can be used while searching tracks. <br />
|
|
|
12852
12902
|
The upc, tag:new and tag:hipster filters can only be used while searching albums.
|
|
12853
12903
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
12854
12904
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
12855
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
12905
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
12856
12906
|
Default: 20, Range: 1 to 50. </li>
|
|
12857
12907
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
12858
12908
|
Use with limit to get the next set of items. <br />
|
|
@@ -13055,7 +13105,7 @@ The isrc and track filters can be used while searching tracks. <br />
|
|
|
13055
13105
|
The upc, tag:new and tag:hipster filters can only be used while searching albums.
|
|
13056
13106
|
The tag:new filter will return albums released in the past two weeks and tag:hipster
|
|
13057
13107
|
can be used to return only albums with the lowest 10% popularity.</li>
|
|
13058
|
-
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items. <br />
|
|
13108
|
+
<li><strong>limit (int):</strong> The maximum number of items to return in a page of items when manual paging is used. <br />
|
|
13059
13109
|
Default: 20, Range: 1 to 50. </li>
|
|
13060
13110
|
<li><strong>offset (int):</strong> The page index offset of the first item to return. <br />
|
|
13061
13111
|
Use with limit to get the next set of items. <br />
|
|
@@ -13217,7 +13267,7 @@ be returned with a search.</p>
|
|
|
13217
13267
|
<div class="attr function">
|
|
13218
13268
|
|
|
13219
13269
|
<span class="def">def</span>
|
|
13220
|
-
<span class="name">SetAuthTokenAuthorizationCode</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">clientId</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">clientSecret</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">scope</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">tokenProfileId</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">forceAuthorize</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">redirectUriHost</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'localhost'</span>,</span><span class="param"> <span class="n">redirectUriPort</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">8080</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
13270
|
+
<span class="name">SetAuthTokenAuthorizationCode</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">clientId</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">clientSecret</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">scope</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">tokenProfileId</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">forceAuthorize</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">redirectUriHost</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'localhost'</span>,</span><span class="param"> <span class="n">redirectUriPort</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">8080</span>,</span><span class="param"> <span class="n">redirectUriPath</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'/'</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
13221
13271
|
|
|
13222
13272
|
|
|
13223
13273
|
</div>
|
|
@@ -13249,6 +13299,9 @@ single port as an integer, or a port range as a list (e.g. [8080,8090]). If a
|
|
|
13249
13299
|
port range is specified, then the logic will loop through the port range looking
|
|
13250
13300
|
for an available port to use. <br />
|
|
13251
13301
|
Default is 8080.</li>
|
|
13302
|
+
<li><strong>redirectUriPath (str):</strong> Path value to add when constructing the redirect_uri; otherwise,
|
|
13303
|
+
None to not add a path value. <br />
|
|
13304
|
+
Default value is '/'.</li>
|
|
13252
13305
|
</ul>
|
|
13253
13306
|
|
|
13254
13307
|
<h6 id="raises">Raises:</h6>
|
|
@@ -13282,8 +13335,8 @@ for a Spotify authorization token.</p>
|
|
|
13282
13335
|
<p>Note that you must have 'http://localhost:8080/' in the Redirect URI allowlist that you
|
|
13283
13336
|
specified when you registered your application in the Spotify Developer Portal. The
|
|
13284
13337
|
redirect URI is case-sensitive, and must contain the trailing slash. You will need to
|
|
13285
|
-
adjust the redirect URI value if you specify custom values using the <code>redirectUriHost</code
|
|
13286
|
-
and <code>
|
|
13338
|
+
adjust the redirect URI value if you specify custom values using the <code>redirectUriHost</code>,
|
|
13339
|
+
<code>redirectUriPort</code>, and <code>redirectUriPath</code> arguments.</p>
|
|
13287
13340
|
</div>
|
|
13288
13341
|
|
|
13289
13342
|
|
|
@@ -13292,7 +13345,7 @@ and <code>redirectUriPort</code> arguments.</p>
|
|
|
13292
13345
|
<div class="attr function">
|
|
13293
13346
|
|
|
13294
13347
|
<span class="def">def</span>
|
|
13295
|
-
<span class="name">SetAuthTokenAuthorizationCodePKCE</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">clientId</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">scope</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">tokenProfileId</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">forceAuthorize</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">redirectUriHost</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'localhost'</span>,</span><span class="param"> <span class="n">redirectUriPort</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">8080</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
13348
|
+
<span class="name">SetAuthTokenAuthorizationCodePKCE</span><span class="signature pdoc-code multiline">(<span class="param"> <span class="bp">self</span>,</span><span class="param"> <span class="n">clientId</span><span class="p">:</span> <span class="nb">str</span>,</span><span class="param"> <span class="n">scope</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">tokenProfileId</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">forceAuthorize</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">redirectUriHost</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'localhost'</span>,</span><span class="param"> <span class="n">redirectUriPort</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">8080</span>,</span><span class="param"> <span class="n">redirectUriPath</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'/'</span></span><span class="return-annotation">) -> <span class="kc">None</span>:</span></span>
|
|
13296
13349
|
|
|
13297
13350
|
|
|
13298
13351
|
</div>
|
|
@@ -13323,6 +13376,9 @@ single port as an integer, or a port range as a list (e.g. [8080,8090]). If a
|
|
|
13323
13376
|
port range is specified, then the logic will loop through the port range looking
|
|
13324
13377
|
for an available port to use. <br />
|
|
13325
13378
|
Default is 8080.</li>
|
|
13379
|
+
<li><strong>redirectUriPath (str):</strong> Path value to add when constructing the redirect_uri; otherwise,
|
|
13380
|
+
None to not add a path value. <br />
|
|
13381
|
+
Default value is '/'.</li>
|
|
13326
13382
|
</ul>
|
|
13327
13383
|
|
|
13328
13384
|
<h6 id="raises">Raises:</h6>
|
|
@@ -13355,8 +13411,8 @@ for a Spotify authorization token.</p>
|
|
|
13355
13411
|
<p>Note that you must have 'http://localhost:8080/' in the Redirect URI allowlist that you
|
|
13356
13412
|
specified when you registered your application in the Spotify Developer Portal. The
|
|
13357
13413
|
redirect URI is case-sensitive, and must contain the trailing slash. You will need to
|
|
13358
|
-
adjust the redirect URI value if you specify custom values using the <code>redirectUriHost</code
|
|
13359
|
-
and <code>
|
|
13414
|
+
adjust the redirect URI value if you specify custom values using the <code>redirectUriHost</code>,
|
|
13415
|
+
<code>redirectUriPort</code>, and <code>redirectUriPath</code> arguments.</p>
|
|
13360
13416
|
</div>
|
|
13361
13417
|
|
|
13362
13418
|
|