/
spotify-web-api-openapi.yml
8012 lines (7957 loc) · 371 KB
/
spotify-web-api-openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Spotify Web API
contact:
name: sonallux
url: https://github.com/sonallux/spotify-web-api
version: 2021.6.18
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference
servers:
- url: https://api.spotify.com/v1
tags:
- name: category-albums
description: Albums API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-albums
- name: category-artists
description: Artists API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-artists
- name: category-browse
description: Browse API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-browse
- name: category-episodes
description: Episodes API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-episodes
- name: category-follow
description: Follow API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-follow
- name: category-library
description: Library API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-library
- name: category-markets
description: Markets API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-markets
- name: category-personalization
description: Personalization API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-personalization
- name: category-player
description: Player API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-player
- name: category-playlists
description: Playlists API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-playlists
- name: category-search
description: Search API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-search
- name: category-shows
description: Shows API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-shows
- name: category-tracks
description: Tracks API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-tracks
- name: category-users-profile
description: Users Profile API
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#category-users-profile
paths:
/albums/{id}:
get:
tags:
- category-albums
summary: Get an Album
description: Get Spotify catalog information for a single album.
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-an-album
operationId: endpoint-get-an-album
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: id
in: path
description: The Spotify ID of the album.
required: true
schema:
type: string
- name: market
in: query
description: The market you'd like to request. Synonym for `country`.
required: false
schema:
type: string
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: "On success, the HTTP status code in the response header is\
\ 200 OK and the response body contains an album object in JSON format.\
\ On error, the header status code is an error code and the response body\
\ contains an error object."
content:
application/json:
schema:
$ref: '#/components/schemas/AlbumObject'
security:
- spotify_auth: []
/albums/{id}/tracks:
get:
tags:
- category-albums
summary: Get an Album's Tracks
description: |-
Get Spotify catalog information about an album's tracks.
Optional parameters can be used to limit the number of tracks returned.
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-an-albums-tracks
operationId: endpoint-get-an-albums-tracks
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: id
in: path
description: The Spotify ID of the album.
required: true
schema:
type: string
- name: market
in: query
description: "An [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\
\ or the string from_token. Provide this parameter if you want to apply\
\ [Track Relinking](https://developer.spotify.com/documentation/general/guides/track-relinking-guide/)."
required: false
schema:
type: string
- name: limit
in: query
description: "The maximum number of tracks to return. Default: 20. Minimum:\
\ 1. Maximum: 50."
required: false
schema:
type: integer
format: int32
- name: offset
in: query
description: "The index of the first track to return. Default: 0 (the first\
\ object). Use with limit to get the next set of tracks."
required: false
schema:
type: integer
format: int32
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: "On success, the HTTP status code in the response header is\
\ 200 OK and the response body contains an album object in JSON format.\
\ On error, the header status code is an error code and the response body\
\ contains an error object."
content:
application/json:
schema:
type: object
properties:
href:
type: string
description: A link to the Web API endpoint returning the full
result of the request
items:
type: array
description: The requested data.
items:
$ref: '#/components/schemas/SimplifiedTrackObject'
limit:
type: integer
description: The maximum number of items in the response (as set
in the query or by default).
format: int32
next:
type: string
description: URL to the next page of items. ( `null` if none)
offset:
type: integer
description: The offset of the items returned (as set in the query
or by default)
format: int32
previous:
type: string
description: URL to the previous page of items. ( `null` if none)
total:
type: integer
description: The total number of items available to return.
format: int32
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#object-pagingobject
security:
- spotify_auth: []
/albums:
get:
tags:
- category-albums
summary: Get Multiple Albums
description: Get Spotify catalog information for multiple albums identified
by their Spotify IDs.
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-multiple-albums
operationId: endpoint-get-multiple-albums
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: ids
in: query
description: "A comma-separated list of the [Spotify IDs](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
\ for the albums. Maximum: 20 IDs."
required: true
schema:
type: string
- name: market
in: query
description: "An [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\
\ or the string from_token. Provide this parameter if you want to apply\
\ [Track Relinking](https://developer.spotify.com/documentation/general/guides/track-relinking-guide/)."
required: false
schema:
type: string
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: |-
On success, the HTTP status code in the response header is `200` OK and the response body contains an object whose key is `"albums"` and whose value is an array of [album objects](https://developer.spotify.com/documentation/web-api/reference/#object-albumobject) in JSON format.
Objects are returned in the order requested. If an object is not found, a `null` value is returned in the appropriate position. Duplicate `ids` in the query will result in duplicate objects in the response. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes) and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema).
content:
application/json:
schema:
$ref: '#/components/schemas/AlbumsObject'
security:
- spotify_auth: []
/artists/{id}:
get:
tags:
- category-artists
summary: Get an Artist
description: Get Spotify catalog information for a single artist identified
by their unique Spotify ID.
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-an-artist
operationId: endpoint-get-an-artist
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: id
in: path
description: The Spotify ID of the artist.
required: true
schema:
type: string
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: "On success, the HTTP status code in the response header is\
\ `200` OK and the response body contains an [artist object](https://developer.spotify.com/documentation/web-api/reference/#object-artistobject)\
\ in JSON format. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes)\
\ and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema)."
content:
application/json:
schema:
$ref: '#/components/schemas/ArtistObject'
security:
- spotify_auth: []
/artists/{id}/albums:
get:
tags:
- category-artists
summary: Get an Artist's Albums
description: Get Spotify catalog information about an artist's albums.
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-an-artists-albums
operationId: endpoint-get-an-artists-albums
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: id
in: path
description: "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
\ for the artist."
required: true
schema:
type: string
- name: include_groups
in: query
description: "A comma-separated list of keywords that will be used to filter\
\ the response. If not supplied, all album types will be returned. Valid\
\ values are: \n- `album` \n- `single` \n- `appears_on` \n- `compilation`\
\ \nFor example: `include_groups=album,single`."
required: false
schema:
type: string
- name: market
in: query
description: "Synonym for `country`. An [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\
\ or the string `from_token`. \nSupply this parameter to limit the response\
\ to one particular geographical market. For example, for albums available\
\ in Sweden: `market=SE`. \n*If not given, results will be returned for\
\ all markets and you are likely to get duplicate results per album, one\
\ for each market in which the album is available!*"
required: false
schema:
type: string
- name: limit
in: query
description: "The number of album objects to return. Default: 20. Minimum:\
\ 1. Maximum: 50. For example: `limit=2`"
required: false
schema:
type: integer
format: int32
- name: offset
in: query
description: "The index of the first album to return. Default: 0 (i.e., the\
\ first album). Use with `limit` to get the next set of albums."
required: false
schema:
type: integer
format: int32
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: "On success, the HTTP status code in the response header is\
\ `200` OK and the response body contains an array of simplified [album\
\ objects](https://developer.spotify.com/documentation/web-api/reference/#object-simplifiedalbumobject)\
\ (wrapped in a [paging object](https://developer.spotify.com/documentation/web-api/reference/#object-pagingobject))\
\ in JSON format. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes)\
\ and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema)."
content:
application/json:
schema:
type: object
properties:
href:
type: string
description: A link to the Web API endpoint returning the full
result of the request
items:
type: array
description: The requested data.
items:
$ref: '#/components/schemas/SimplifiedAlbumObject'
limit:
type: integer
description: The maximum number of items in the response (as set
in the query or by default).
format: int32
next:
type: string
description: URL to the next page of items. ( `null` if none)
offset:
type: integer
description: The offset of the items returned (as set in the query
or by default)
format: int32
previous:
type: string
description: URL to the previous page of items. ( `null` if none)
total:
type: integer
description: The total number of items available to return.
format: int32
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#object-pagingobject
security:
- spotify_auth: []
/artists/{id}/related-artists:
get:
tags:
- category-artists
summary: Get an Artist's Related Artists
description: "Get Spotify catalog information about artists similar to a given\
\ artist. Similarity is based on analysis of the Spotify community's [listening\
\ history](http://news.spotify.com/se/2010/02/03/related-artists/)."
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-an-artists-related-artists
operationId: endpoint-get-an-artists-related-artists
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: id
in: path
description: "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
\ for the artist"
required: true
schema:
type: string
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: "On success, the HTTP status code in the response header is\
\ `200` OK and the response body contains an object whose key is `\"artists\"\
` and whose value is an array of up to 20 [artist objects](https://developer.spotify.com/documentation/web-api/reference/#object-artistobject)\
\ in JSON format. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes)\
\ and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema)."
content:
application/json:
schema:
$ref: '#/components/schemas/ArtistsObject'
security:
- spotify_auth: []
/artists/{id}/top-tracks:
get:
tags:
- category-artists
summary: Get an Artist's Top Tracks
description: Get Spotify catalog information about an artist's top tracks by
country.
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-an-artists-top-tracks
operationId: endpoint-get-an-artists-top-tracks
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: id
in: path
description: "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
\ for the artist"
required: true
schema:
type: string
- name: market
in: query
description: "An [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\
\ or the string `from_token`. Synonym for `country`."
required: true
schema:
type: string
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: "On success, the HTTP status code in the response header is\
\ `200` OK and the response body contains an object whose key is `\"tracks\"\
` and whose value is an array of up to 10 [track objects](https://developer.spotify.com/documentation/web-api/reference/#object-trackobject)\
\ in JSON format. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes)\
\ and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema)."
content:
application/json:
schema:
$ref: '#/components/schemas/TracksObject'
security:
- spotify_auth: []
/artists:
get:
tags:
- category-artists
summary: Get Multiple Artists
description: Get Spotify catalog information for several artists based on their
Spotify IDs.
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-multiple-artists
operationId: endpoint-get-multiple-artists
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: ids
in: query
description: "A comma-separated list of the [Spotify IDs](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
\ for the artists. Maximum: 50 IDs."
required: true
schema:
type: string
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: |-
On success, the HTTP status code in the response header is `200` OK and the response body contains an object whose key is `"artists"` and whose value is an array of [artist objects](https://developer.spotify.com/documentation/web-api/reference/#object-artistobject) in JSON format.
Objects are returned in the order requested. If an object is not found, a `null` value is returned in the appropriate position. Duplicate `ids` in the query will result in duplicate objects in the response. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes) and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema).
content:
application/json:
schema:
$ref: '#/components/schemas/ArtistsObject'
security:
- spotify_auth: []
/browse/categories/{category_id}/playlists:
get:
tags:
- category-browse
summary: Get a Category's Playlists
description: Get a list of Spotify playlists tagged with a particular category.
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-a-categories-playlists
operationId: endpoint-get-a-categories-playlists
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: category_id
in: path
description: "The [Spotify category ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
\ for the category."
required: true
schema:
type: string
- name: country
in: query
description: "A country: an [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\
\ Provide this parameter to ensure that the category exists for a particular\
\ country."
required: false
schema:
type: string
- name: limit
in: query
description: "The maximum number of items to return. Default: 20. Minimum:\
\ 1. Maximum: 50."
required: false
schema:
type: integer
format: int32
- name: offset
in: query
description: "The index of the first item to return. Default: 0 (the first\
\ object). Use with `limit` to get the next set of items."
required: false
schema:
type: integer
format: int32
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: |-
On success, the HTTP status code in the response header is `200` OK and the response body contains an array of simplified [playlist objects](https://developer.spotify.com/documentation/web-api/reference/#object-simplifiedplaylistobject) (wrapped in a [paging object](https://developer.spotify.com/documentation/web-api/reference/#object-pagingobject)) in JSON format. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes) and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema).
Once you have retrieved the list, you can use [Get a Playlist](https://developer.spotify.com/web-api/get-playlist/) and [Get a Playlist's Tracks](https://developer.spotify.com/web-api/get-playlists-tracks/) to drill down further.
content:
application/json:
schema:
$ref: '#/components/schemas/PlaylistPagingObject'
security:
- spotify_auth: []
/browse/categories/{category_id}:
get:
tags:
- category-browse
summary: Get a Category
description: "Get a single category used to tag items in Spotify (on, for example,\
\ the Spotify player's \"Browse\" tab)."
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-a-category
operationId: endpoint-get-a-category
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: category_id
in: path
description: "The [Spotify category ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
\ for the category."
required: true
schema:
type: string
- name: country
in: query
description: "A country: an [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\
\ Provide this parameter to ensure that the category exists for a particular\
\ country."
required: false
schema:
type: string
- name: locale
in: query
description: "The desired language, consisting of an [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1)\
\ language code and an [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2),\
\ joined by an underscore. For example: `es_MX`, meaning \"Spanish (Mexico)\"\
. Provide this parameter if you want the category strings returned in a\
\ particular language. Note that, if `locale` is not supplied, or if the\
\ specified language is not available, the category strings returned will\
\ be in the Spotify default language (American English)."
required: false
schema:
type: string
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: |-
On success, the HTTP status code in the response header is `200` OK and the response body contains a [category object](#categoryobject) in JSON format. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes) and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema).
Once you have retrieved the category, you can use [Get a Category's Playlists](https://developer.spotify.com/web-api/get-categorys-playlists/) to drill down further.
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryObject'
security:
- spotify_auth: []
/browse/categories:
get:
tags:
- category-browse
summary: Get All Categories
description: "Get a list of categories used to tag items in Spotify (on, for\
\ example, the Spotify player's \"Browse\" tab)."
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-categories
operationId: endpoint-get-categories
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: country
in: query
description: "A country: an [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\
\ Provide this parameter if you want to narrow the list of returned categories\
\ to those relevant to a particular country. If omitted, the returned items\
\ will be globally relevant."
required: false
schema:
type: string
- name: locale
in: query
description: "The desired language, consisting of an [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1)\
\ language code and an [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2),\
\ joined by an underscore. For example: `es_MX`, meaning \"Spanish (Mexico)\"\
. Provide this parameter if you want the category metadata returned in a\
\ particular language. Note that, if `locale` is not supplied, or if the\
\ specified language is not available, all strings will be returned in the\
\ Spotify default language (American English). The `locale` parameter, combined\
\ with the `country` parameter, may give odd results if not carefully matched.\
\ For example `country=SE&locale=de_DE` will return a list of categories\
\ relevant to Sweden but as German language strings."
required: false
schema:
type: string
- name: limit
in: query
description: "The maximum number of categories to return. Default: 20. Minimum:\
\ 1. Maximum: 50."
required: false
schema:
type: integer
format: int32
- name: offset
in: query
description: "The index of the first item to return. Default: 0 (the first\
\ object). Use with `limit` to get the next set of categories."
required: false
schema:
type: integer
format: int32
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: |-
On success, the HTTP status code in the response header is `200` OK and the response body contains an object with a `categories` field, with an array of [category objects](#categoryobject) (wrapped in a [paging object](https://developer.spotify.com/documentation/web-api/reference/#object-pagingobject)) in JSON format. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes) and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema).
Once you have retrieved the list, you can use [Get a Category](https://developer.spotify.com/web-api/get-category/) to drill down further.
content:
application/json:
schema:
$ref: '#/components/schemas/CategoriesObject'
security:
- spotify_auth: []
/browse/featured-playlists:
get:
tags:
- category-browse
summary: Get All Featured Playlists
description: "Get a list of Spotify featured playlists (shown, for example,\
\ on a Spotify player's 'Browse' tab)."
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-featured-playlists
operationId: endpoint-get-featured-playlists
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: country
in: query
description: "A country: an [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\
\ Provide this parameter if you want the list of returned items to be relevant\
\ to a particular country. If omitted, the returned items will be relevant\
\ to all countries."
required: false
schema:
type: string
- name: locale
in: query
description: "The desired language, consisting of a lowercase [ISO 639-1 language\
\ code](http://en.wikipedia.org/wiki/ISO_639-1) and an uppercase [ISO 3166-1\
\ alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2),\
\ joined by an underscore. For example: `es_MX`, meaning \"Spanish (Mexico)\"\
. Provide this parameter if you want the results returned in a particular\
\ language (where available). Note that, if `locale` is not supplied, or\
\ if the specified language is not available, all strings will be returned\
\ in the Spotify default language (American English). The `locale` parameter,\
\ combined with the `country` parameter, may give odd results if not carefully\
\ matched. For example `country=SE&locale=de_DE` will return a list of categories\
\ relevant to Sweden but as German language strings."
required: false
schema:
type: string
- name: timestamp
in: query
description: "A timestamp in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601):\
\ `yyyy-MM-ddTHH:mm:ss`. Use this parameter to specify the user's local\
\ time to get results tailored for that specific date and time in the day.\
\ If not provided, the response defaults to the current UTC time. Example:\
\ \"2014-10-23T09:00:00\" for a user whose local time is 9AM. If there were\
\ no featured playlists (or there is no data) at the specified time, the\
\ response will revert to the current UTC time."
required: false
schema:
type: string
- name: limit
in: query
description: "The maximum number of items to return. Default: 20. Minimum:\
\ 1. Maximum: 50."
required: false
schema:
type: integer
format: int32
- name: offset
in: query
description: "The index of the first item to return. Default: 0 (the first\
\ object). Use with `limit` to get the next set of items."
required: false
schema:
type: integer
format: int32
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: |-
On success, the HTTP status code in the response header is `200` OK and the response body contains a `message` and a `playlists` object. The `playlists` object contains an array of simplified [playlist objects](https://developer.spotify.com/documentation/web-api/reference/#object-simplifiedplaylistobject) (wrapped in a [paging object](https://developer.spotify.com/documentation/web-api/reference/#object-pagingobject)) in JSON format. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes) and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema).
Once you have retrieved the list of playlist objects, you can use [Get a Playlist](https://developer.spotify.com/web-api/get-playlist/) and [Get a Playlist's Tracks](https://developer.spotify.com/web-api/get-playlists-tracks/) to drill down further.
content:
application/json:
schema:
$ref: '#/components/schemas/FeaturedPlaylistObject'
security:
- spotify_auth: []
/browse/new-releases:
get:
tags:
- category-browse
summary: Get All New Releases
description: "Get a list of new album releases featured in Spotify (shown, for\
\ example, on a Spotify player's \"Browse\" tab)."
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-new-releases
operationId: endpoint-get-new-releases
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: country
in: query
description: "A country: an [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\
\ Provide this parameter if you want the list of returned items to be relevant\
\ to a particular country. If omitted, the returned items will be relevant\
\ to all countries."
required: false
schema:
type: string
- name: limit
in: query
description: "The maximum number of items to return. Default: 20. Minimum:\
\ 1. Maximum: 50."
required: false
schema:
type: integer
format: int32
- name: offset
in: query
description: "The index of the first item to return. Default: 0 (the first\
\ object). Use with `limit` to get the next set of items."
required: false
schema:
type: integer
format: int32
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: |-
On success, the HTTP status code in the response header is `200` OK and the response body contains a `message` and an`albums` object. The `albums` object contains an array of simplified [album objects](https://developer.spotify.com/documentation/web-api/reference/#object-simplifiedalbumobject) (wrapped in a [paging object](https://developer.spotify.com/documentation/web-api/reference/#object-pagingobject)) in JSON format. On error, the header status code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes) and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema).
Once you have retrieved the list, you can use [Get an Album's Tracks](https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-an-albums-tracks) to drill down further.
The results are returned in an order reflected within the Spotify clients, and therefore may not be ordered by date.
content:
application/json:
schema:
$ref: '#/components/schemas/NewReleasesObject'
security:
- spotify_auth: []
/recommendations/available-genre-seeds:
get:
tags:
- category-browse
summary: Get Recommendation Genres
description: "Retrieve a list of available genres seed parameter values for\
\ [recommendations](https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-recommendations)."
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-recommendation-genres
operationId: endpoint-get-recommendation-genres
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
responses:
default:
$ref: '#/components/responses/ErrorResponse'
"200":
description: "On success, the HTTP status code in the response header is\
\ `200 OK` and the response body contains a recommendations response object\
\ in JSON format."
content:
application/json:
schema:
$ref: '#/components/schemas/GenreSeedsObject'
security:
- spotify_auth: []
/recommendations:
get:
tags:
- category-browse
summary: Get Recommendations
description: "Recommendations are generated based on the available information\
\ for a given seed entity and matched against similar artists and tracks.\
\ If there is sufficient information about the provided seeds, a list of tracks\
\ will be returned together with pool size details."
externalDocs:
description: Find more info on the official Spotify Web API Reference
url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-recommendations
operationId: endpoint-get-recommendations
parameters:
- name: Authorization
in: header
description: A valid user access token or your client credentials.
required: true
schema:
type: string
- name: limit
in: query
description: "The target size of the list of recommended tracks. For seeds\
\ with unusually small pools or when highly restrictive filtering is applied,\
\ it may be impossible to generate the requested number of recommended tracks.\
\ Debugging information for such cases is available in the response. Default:\
\ 20. Minimum: 1. Maximum: 100."
required: false
schema:
type: integer
format: int32
- name: market
in: query
description: "An [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\
\ or the string `from_token`. Provide this parameter if you want to apply\
\ [Track Relinking](https://developer.spotify.com/documentation/general/guides/track-relinking-guide).\
\ Because `min_*`, `max_*` and `target_*` are applied to pools before relinking,\
\ the generated results may not precisely match the filters applied. Original,\
\ non-relinked tracks are available via the `linked_from` attribute of the\
\ [relinked track response](https://developer.spotify.com/documentation/general/guides/track-relinking-guide)."
required: false
schema:
type: string
- name: seed_artists
in: query
description: "A comma separated list of [Spotify IDs](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
\ for seed artists. Up to 5 seed values may be provided in any combination\
\ of `seed_artists`, `seed_tracks` and `seed_genres`."
required: true
schema:
type: string
- name: seed_genres
in: query
description: "A comma separated list of any genres in the set of [available\
\ genre seeds](#available-genre-seeds). Up to 5 seed values may be provided\
\ in any combination of `seed_artists`, `seed_tracks` and `seed_genres`."
required: true
schema:
type: string
- name: seed_tracks
in: query
description: "A comma separated list of [Spotify IDs](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
\ for a seed track. Up to 5 seed values may be provided in any combination\
\ of `seed_artists`, `seed_tracks` and `seed_genres`."
required: true
schema:
type: string
- name: min_acousticness
in: query
description: "For each tunable track attribute, a hard floor on the selected\
\ track attribute's value can be provided. See tunable track attributes\
\ below for the list of available options. For example, `min_tempo=140`\
\ would restrict results to only those tracks with a tempo of greater than\
\ 140 beats per minute."
required: false
schema:
type: number
- name: max_acousticness
in: query
description: "For each tunable track attribute, a hard ceiling on the selected\
\ track attribute's value can be provided. See tunable track attributes\
\ below for the list of available options. For example, `max_instrumentalness=0.35`\
\ would filter out most tracks that are likely to be instrumental."
required: false
schema:
type: number
- name: target_acousticness
in: query