From dad2065044314cf8eb048882aa7b1d0aded0c2aa Mon Sep 17 00:00:00 2001 From: Patrick Griffis Date: Mon, 4 Dec 2017 14:23:03 -0500 Subject: Document more of the REST API --- rest/index.rst | 5 + rest/listener.rst | 28 +++ rest/music.rst | 90 +++++++++ rest/ondemand.rst | 136 +++++++++++++ rest/playlist.rst | 144 +++++++++++++ rest/search.rst | 168 ++++++++++++++++ rest/stations.rst | 593 +++++++++++++++++++++++++++++++++++++++++++++++++----- 7 files changed, 1110 insertions(+), 54 deletions(-) create mode 100644 rest/listener.rst create mode 100644 rest/music.rst create mode 100644 rest/ondemand.rst create mode 100644 rest/playlist.rst create mode 100644 rest/search.rst (limited to 'rest') diff --git a/rest/index.rst b/rest/index.rst index cc380c9..46cc37e 100644 --- a/rest/index.rst +++ b/rest/index.rst @@ -25,6 +25,11 @@ requirement for time syncronization, Blowfish cryptography, or partner logins. ads endpoints errorcodes + music + ondemand + playlist + search + listener .. _rest-csrf-token: diff --git a/rest/listener.rst b/rest/listener.rst new file mode 100644 index 0000000..3dfba76 --- /dev/null +++ b/rest/listener.rst @@ -0,0 +1,28 @@ +.. _rest-listener: + +======== +Listener +======== + +.. _rest-v1-listener-addTiredSong: + +Add Tired Song +============== + +:Endpoint: /v1/listener/addTiredSong + +Request +------- +.. code:: json + + { + "trackToken": "POV87XDIa0WzVs1yFGsa4D5UPmVsZ9z-F1Oa1wNdpYk2_Q0RDUKG3_VJ2AOSwjBUYZMJcJ8gd5mWlqpcZAHWPbQ" + } + +Response +-------- +.. code:: json + + {} + + \ No newline at end of file diff --git a/rest/music.rst b/rest/music.rst new file mode 100644 index 0000000..991eb91 --- /dev/null +++ b/rest/music.rst @@ -0,0 +1,90 @@ +.. _rest-music: + +===== +Music +===== + +.. _rest-v1-music-artist: + +Artist +====== + +:Endpoint: /v1/music/artist + +Request +------- +.. code:: json + + { + "token": "R734008" + } + +Response +-------- +.. code:: json + + { + "listenerCount": 11991, + "isBookmarked": false, + "discography": [ + { + "musicId": "L668139", + "pandoraId": "AL:668139", + "seoToken": "steve-aoki-louis-tomlinson/just-hold-on-single/ALXVgJnJXrtl9f6", + "albumTitle": "Just Hold On (Single)", + "art": [ + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/6/5/6/3/0617465833656_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://mediaserver-cont-sv5-2-v4v6.pandora.com/images/public/int/6/5/6/3/0617465833656_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/int/6/5/6/3/0617465833656_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://cont-1.p-cdn.com/images/public/int/6/5/6/3/0617465833656_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://cont-1.p-cdn.com/images/public/int/6/5/6/3/0617465833656_1080W_1080H.jpg", + "size": 1080 + } + ], + "year": "2016" + } + ], + "similar": [ + { + "musicId": "R355704", + "pandoraId": "AR:355704", + "name": "One Direction", + "art": [ + { + "url": "https://mediaserver-cont-dc6-1-v4v6.pandora.com/images/public/rovi/portrait/2/9/5/6/MN0002766592_200W.jpg", + "size": 200 + }, + { + "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/rovi/portrait/2/9/5/6/MN0002766592_640W.jpg", + "size": 640 + }, + { + "url": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/rovi/portrait/2/9/5/6/MN0002766592.jpg", + "size": 1080 + } + ], + "seoToken": "1-direction/ARtp2br9jh6pVX4", + "detailUrl": "https://www.pandora.com/artist/1-direction/ARtp2br9jh6pVX4" + } + ], + "events": [], + "musicId": "R734008", + "pandoraId": "AR:734008", + "name": "Steve Aoki & Louis Tomlinson", + "art": [], + "seoToken": "steve-aoki-louis-tomlinson/ARkmbKd6rz2Xq79", + "detailUrl": "https://www.pandora.com/artist/steve-aoki-louis-tomlinson/ARkmbKd6rz2Xq79" + } \ No newline at end of file diff --git a/rest/ondemand.rst b/rest/ondemand.rst new file mode 100644 index 0000000..2928a7e --- /dev/null +++ b/rest/ondemand.rst @@ -0,0 +1,136 @@ +.. _rest-ondemand: + +========= +On Demand +========= + +.. _rest-v1-ondemand-getReplayTrack: + +Get Replay Track +================ + +:Endpoint: /v1/ondemand/getReplayTrack + +Request +------- +.. code:: json + + { + "stationId": "3793312577613735337", + "trackToken": "PTlqhbC-55drVs1yFGsa4D5UPmVsZ9z-F1Oa1wNdpYk2_Q0RDUKG3_U3vDcuVW3DPa8Lf2OA5ToR4nulgKysBkw", + "artistUid": null, + "lastPlayedTrackToken": "PTlqhbC-55drVs1yFGsa4D5UPmVsZ9z-F1Oa1wNdpYk2_Q0RDUKG3_U3vDcuVW3DPa8Lf2OA5ToR4nulgKysBkw" + } + +Response +-------- +.. code:: json + + { + "replayTrack": { + "genre": [ + "Rock" + ], + "monthlyListening": 0, + "listeningTimestamp": "1512414066090", + "shareLandingURL": "https://www.pandora.com/niall-horan/slow-hands-single/slow-hands/TRXgqVhPXtj3k9g?shareImp=true", + "isSeed": false, + "allowStartStationFromTrack": true, + "allowShareTrack": true, + "allowBuyTrack": true, + "allowTiredOfTrack": true, + "allowSkipTrackWithoutLimit": false, + "allowSkip": true, + "allowFeedback": true, + "composerName": "", + "artistSeoToken": "niall-horan/AR3cxZc3P2dllcq", + "albumSeoToken": "niall-horan/slow-hands-single/ALjcm3n766qqcKZ", + "isCompilation": false, + "amazonUrl": "https://www.amazon.com/gp/search/?index=music&field-artist=Niall+Horan&field-title=Slow+Hands+%28Single%29&tag=wwwpandoracom-20", + "amazonDigitalAsin": "B071KHGZVJ", + "albumAmazonDigitalAsin": "B072KQKMRL", + "itunesUrl": "https://itunes.apple.com/album/slow-hands/id1230745029?i=1230745661&uo=5&at=11l3Hh&app=itunes", + "isFeatured": false, + "isBookmarked": false, + "adUrls": { + "flexSkipAdUrl": "https://adserver.pandora.com/haymaker/api/v1/serve/?slot=FLEX_SKIP&targeting=a11%3D10,15,22,27,6%3Baa%3D0%3Bab%3D100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88%3Bag%3D24%3Bapp%3D%3Bclean%3D0%3Bco%3D18039%3Bcon%3D%3Bd1%3D3%3Bd2%3D73%3Bd3%3D154%3Bd4%3D1748,1750,1881%3Bd8%3D0%3Bdma%3D588%3Bet%3D2%3Bfam%3D-1%3Bgcat%3DG1473%3Bgenre%3Dlatin%3Bgnd%3D1%3Bhhi%3D0%3Bhisp%3D0%3Bhours%3D0%3Bindex%3D__INDEX__%3Binteraction%3Dskip_limit%3Bmc%3D%3Bmodel%3D%3Bmsa%3D%3Bp%3D1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964%3Bp13%3D2%3Bp8%3D2%3Bst%3DIN%3Bstation%3D%3Bt4%3D257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906%3Buq%3Dbf756e84b44d3c48c4b2fc493aa56950%3Bvx%3D%3Bzip%3D46516&l=p6xbtu7t3jyucnip5g65vzwxxg27tgozglljkwy&zone=prod.__ZONE__&site=default&env=prod&assetType=COACHMARK&ppid=bf756e84b44d3c48c4b2fc493aa56950&c=__CACHEBUST__", + "flexReplayAdUrl": "https://adserver.pandora.com/haymaker/api/v1/serve/?slot=FLEX_REPLAY&targeting=a11%3D10,15,22,27,6%3Baa%3D0%3Bab%3D100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88%3Bag%3D24%3Bapp%3D%3Bclean%3D0%3Bco%3D18039%3Bcon%3D%3Bd1%3D3%3Bd2%3D73%3Bd3%3D154%3Bd4%3D1748,1750,1881%3Bd8%3D0%3Bdma%3D588%3Bet%3D2%3Bfam%3D-1%3Bgcat%3DG1473%3Bgenre%3Dlatin%3Bgnd%3D1%3Bhhi%3D0%3Bhisp%3D0%3Bhours%3D0%3Bindex%3D__INDEX__%3Binteraction%3Dreplay%3Bmc%3D%3Bmodel%3D%3Bmsa%3D%3Bp%3D1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964%3Bp13%3D2%3Bp8%3D2%3Bst%3DIN%3Bstation%3D%3Bt4%3D257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906%3Buq%3Dbf756e84b44d3c48c4b2fc493aa56950%3Bvx%3D%3Bzip%3D46516&l=6t763hlvimp6zbqq6gc7wuuaz6gmrcqgubdgccq&zone=prod.__ZONE__&site=default&env=prod&assetType=COACHMARK&ppid=bf756e84b44d3c48c4b2fc493aa56950&c=__CACHEBUST__", + "flexThumbsDownAdUrl": "https://adserver.pandora.com/haymaker/api/v1/serve/?slot=FLEX_THUMBS_DOWN&targeting=a11%3D10,15,22,27,6%3Baa%3D0%3Bab%3D100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88%3Bag%3D24%3Bapp%3D%3Bclean%3D0%3Bco%3D18039%3Bcon%3D%3Bd1%3D3%3Bd2%3D73%3Bd3%3D154%3Bd4%3D1748,1750,1881%3Bd8%3D0%3Bdma%3D588%3Bet%3D2%3Bfam%3D-1%3Bgcat%3DG1473%3Bgenre%3Dlatin%3Bgnd%3D1%3Bhhi%3D0%3Bhisp%3D0%3Bhours%3D0%3Bindex%3D__INDEX__%3Binteraction%3Dskip_limit%3Bmc%3D%3Bmodel%3D%3Bmsa%3D%3Bp%3D1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964%3Bp13%3D2%3Bp8%3D2%3Bst%3DIN%3Bstation%3D%3Bt4%3D257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906%3Buq%3Dbf756e84b44d3c48c4b2fc493aa56950%3Bvx%3D%3Bzip%3D46516&l=kjnmkelcpvg6z5tgomml4eentvrpevp7wd7g6ty&zone=prod.__ZONE__&site=default&env=prod&assetType=COACHMARK&ppid=bf756e84b44d3c48c4b2fc493aa56950&c=__CACHEBUST__", + "nowPlayingStationAdUrl": "https://pubads.g.doubleclick.net/gampad/adx?iu=/4204/pand.default/prod.radio&t=a11%3D10,15,22,27,6%26aa%3D0%26ab%3D100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88%26abx%3D654,1454,983,487,484,632,985,448,631,1431,1289,424,485,646,1193,1412,1158,402,989,1156,906,907,1414,429,984,1118,1159%26ag%3D24%26artist%3DG1473%26async%3D0%26clean%3D0%26co%3D18039%26comped%3D0%26d1%3D3%26d2%3D73%26d3%3D154%26d4%3D1748,1750,1881%26d8%3D0%26dma%3D588%26dse%3D0%26et%3D2%26exp%3D0%26fam%3D-1%26fb%3D0%26gcat%3DG1473%26gnd%3D1%26hhi%3D0%26hisp%3D0%26hours%3D0%26iat%3D0%26index%3D__INDEX__%26interaction%3D__ACTION__%26l%3D54tfqfsxzoem5yprkm32fn7pvsqyeqvlgzaigai%26p%3D1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964%26p13%3D2%26p8%3D2%26prg%3D1%26st%3DIN%26t4%3D257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906%26uq%3Dbf756e84b44d3c48c4b2fc493aa56950%26zip%3D46516&ppid=bf756e84b44d3c48c4b2fc493aa56950&sz=2000x2%7C300x250%7C300x600&c=__CACHEBUST__", + "nowPlayingStationAdUnit": "/4204/pand.default/prod.radio", + "nowPlayingStationAdTargeting": "a11=10,15,22,27,6;aa=0;ab=100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88;abx=654,1454,983,487,484,632,985,448,631,1431,1289,424,485,646,1193,1412,1158,402,989,1156,906,907,1414,429,984,1118,1159;ag=24;artist=G1473;async=0;clean=0;co=18039;comped=0;d1=3;d2=73;d3=154;d4=1748,1750,1881;d8=0;dma=588;dse=0;et=2;exp=0;fam=-1;fb=0;gcat=G1473;gnd=1;hhi=0;hisp=0;hours=0;iat=0;index=__INDEX__;interaction=__ACTION__;l=54tfqfsxzoem5yprkm32fn7pvsqyeqvlgzaigai;p=1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964;p13=2;p8=2;prg=1;st=IN;t4=257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906;uq=bf756e84b44d3c48c4b2fc493aa56950;zip=46516", + "backstageAdUrl": "https://pubads.g.doubleclick.net/gampad/adx?iu=/4204/pand.default/prod.backstage&t=a11%3D10,15,22,27,6%26aa%3D0%26ab%3D100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88%26abx%3D654,1454,983,487,484,632,985,448,631,1431,1289,424,485,646,1193,1412,1158,402,989,1156,906,907,1414,429,984,1118,1159%26ag%3D24%26artist%3DG1473%26async%3D0%26clean%3D0%26co%3D18039%26comped%3D0%26d1%3D3%26d2%3D73%26d3%3D154%26d4%3D1748,1750,1881%26d8%3D0%26dma%3D588%26dse%3D0%26et%3D2%26exp%3D0%26fam%3D-1%26fb%3D0%26gcat%3DG1473%26gnd%3D1%26hhi%3D0%26hisp%3D0%26hours%3D0%26iat%3D0%26index%3D__INDEX__%26interaction%3D__ACTION__%26l%3Dnogknuaboqvvd2cjzueprcees3ynsuwhiktkrzi%26p%3D1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964%26p13%3D2%26p8%3D2%26prg%3D1%26st%3DIN%26t4%3D257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906%26uq%3Dbf756e84b44d3c48c4b2fc493aa56950%26zip%3D46516&ppid=bf756e84b44d3c48c4b2fc493aa56950&sz=2000x2%7C300x250%7C300x600&c=__CACHEBUST__", + "backstageAdUnit": "/4204/pand.default/prod.backstage", + "backstageAdTargeting": "a11=10,15,22,27,6;aa=0;ab=100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88;abx=654,1454,983,487,484,632,985,448,631,1431,1289,424,485,646,1193,1412,1158,402,989,1156,906,907,1414,429,984,1118,1159;ag=24;artist=G1473;async=0;clean=0;co=18039;comped=0;d1=3;d2=73;d3=154;d4=1748,1750,1881;d8=0;dma=588;dse=0;et=2;exp=0;fam=-1;fb=0;gcat=G1473;gnd=1;hhi=0;hisp=0;hours=0;iat=0;index=__INDEX__;interaction=__ACTION__;l=nogknuaboqvvd2cjzueprcees3ynsuwhiktkrzi;p=1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964;p13=2;p8=2;prg=1;st=IN;t4=257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906;uq=bf756e84b44d3c48c4b2fc493aa56950;zip=46516" + }, + "songTitle": "Slow Hands", + "musicId": "S10296263", + "trackType": "Track", + "pandoraId": "TR:10296263", + "trackToken": "PYni_BApMiMTVs1yFGsa4D5UPmVsZ9z-F1Oa1wNdpYk1N-E9BmzIVR-5BilW0cYCPzjLr7tncQ0Y", + "identity": "41561d0348209a43fd397f2baa1b41ad", + "trackLength": 188, + "rating": 0, + "stationId": "3793312577613735337", + "fileGain": "-3.75", + "songDetailURL": "https://www.pandora.com/artist/niall-horan/slow-hands-single/slow-hands/TRXgqVhPXtj3k9g", + "trackSeoToken": "niall-horan/slow-hands-single/slow-hands/TRXgqVhPXtj3k9g", + "audioURL": "https://audio-sv5-t1-2-v4v6.pandora.com/access/8295721970817038911?version=5&lid=112207273&token=XEN2HidhYjgfogBMtj9evUwAjzAFwRswXJhW88OS7qSpjbn0IO4W5VBx%2BW6cD0jm4QBRBOLYuZcZE1OIgNbRDCdfx1wy6rhdDwqKsF1In3VXRfdh4OWagP1fP%2B8iTxYz%2FX6kM17e2jTyu8DJ9ecF92AbT6aUhm1zLH8kWjxW6%2FA%2Fw94ax9mt8PF6hIlJdmB9Sj4A72muVtodmpfMxE5dXGqKLFQqZH9YfBDe%2FV6oDTCXM9f8UYCby55%2Bj8LYX3U7Ms673A8U4OJp2%2BeZ1ZDSMGN9fQaSrjnVYaVQkTp10ET8JsJVirOZMKXG4wYFcgO0sgZI%2Br40JZs%3D", + "rights": [ + "replayRequiresReward", + "allowSkipAfterLimit", + "showReplayButton", + "allowReplay" + ], + "audioEncoding": "mp3", + "audioTokenId": "jpa9al64q", + "audioReceiptURL": "https://audio-sv5-t1-2-v4v6.pandora.com/receipt/?version=5&receiptId=XEN2HidhYji2L5ERGVG7C%2B0hgdc9xMCD&token=XEN2HidhYjgfogBMtj9evUwAjzAFwRswXJhW88OS7qSpjbn0IO4W5VBx%2BW6cD0jm4QBRBOLYuZcZE1OIgNbRDCdfx1wy6rhdDwqKsF1In3VXRfdh4OWagP1fP%2B8iTxYz%2FX6kM17e2jTyu8DJ9ecF92AbT6aUhm1zLH8kWjxW6%2FA%2Fw94ax9mt8PF6hIlJdmB9Sj4A72muVtodmpfMxE5dXGqKLFQqZH9YfBDe%2FV6oDTCXM9f8UYCby55%2Bj8LYX3U7Ms673A8U4OJp2%2BeZ1ZDSMGN9fQaSrjnVYaVQkTp10ET8JsJVirOZMKXG4wYFcgO0sgZI%2Br40JZs%3D", + "audioSkipUrl": "https://audio-sv5-t1-2-v4v6.pandora.com/skip/?version=5&token=XEN2HidhYjgfogBMtj9evUwAjzAFwRswXJhW88OS7qSpjbn0IO4W5VBx%2BW6cD0jm4QBRBOLYuZcZE1OIgNbRDCdfx1wy6rhdDwqKsF1In3VXRfdh4OWagP1fP%2B8iTxYz%2FX6kM17e2jTyu8DJ9ecF92AbT6aUhm1zLH8kWjxW6%2FA%2Fw94ax9mt8PF6hIlJdmB9Sj4A72muVtodmpfMxE5dXGqKLFQqZH9YfBDe%2FV6oDTCXM9f8UYCby55%2Bj8LYX3U7Ms673A8U4OJp2%2BeZ1ZDSMGN9fQaSrjnVYaVQkTp10ET8JsJVirOZMKXG4wYFcgO0sgZI%2Br40JZs%3D", + "artistName": "Niall Horan", + "artistMusicId": "R713137", + "artistArt": [ + { + "url": "https://cont-2.p-cdn.com/images/public/rovi/portrait/7/4/5/4/MN0002854547_200W.jpg", + "size": 200 + }, + { + "url": "https://cont-1.p-cdn.com/images/public/rovi/portrait/7/4/5/4/MN0002854547_640W.jpg", + "size": 640 + }, + { + "url": "https://mediaserver-cont-ch1-2-v4v6.pandora.com/images/public/rovi/portrait/7/4/5/4/MN0002854547.jpg", + "size": 1080 + } + ], + "artistDetailURL": "https://www.pandora.com/artist/niall-horan/AR3cxZc3P2dllcq", + "albumTitle": "Slow Hands (Single)", + "albumArt": [ + { + "url": "https://cont-1.p-cdn.com/images/public/int/9/7/2/1/00602557661279_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://mediaserver-cont-sv5-2-v4v6.pandora.com/images/public/int/9/7/2/1/00602557661279_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://mediaserver-cont-ch1-1-v4v6.pandora.com/images/public/int/9/7/2/1/00602557661279_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/int/9/7/2/1/00602557661279_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/9/7/2/1/00602557661279_1080W_1080H.jpg", + "size": 1080 + } + ], + "albumDetailURL": "https://www.pandora.com/artist/niall-horan/slow-hands-single/ALjcm3n766qqcKZ", + "trackKey": { + "trackId": "S10296263", + "trackType": "Track", + "spinId": "d89b00a7-f6fa-4a5e-85c0-bcc47ef536c4" + } + } + } \ No newline at end of file diff --git a/rest/playlist.rst b/rest/playlist.rst new file mode 100644 index 0000000..aa085b7 --- /dev/null +++ b/rest/playlist.rst @@ -0,0 +1,144 @@ +.. _rest-playlist: + +======== +Playlist +======== + +.. _rest-v1-playlist-getFragment: + +Get Fragment +============ + +:Endpoint: /v1/playlist/getFragment + +Request +------- +.. code:: json + + { + "stationId": "3793312577613735337", + "isStationStart": true, + "fragmentRequestReason": "Normal", + "audioFormat": "aacplus", + "startingAtTrackId": null, + "onDemandArtistMessageArtistUidHex": null, + "onDemandArtistMessageIdHex": null + } + +Response +-------- +.. code:: json + + { + "tracks": [ + { + "userSeed": "G1473", + "genre": [ + "Rock" + ], + "monthlyListening": 0, + "listeningTimestamp": "1512414066099", + "shareLandingURL": "https://www.pandora.com/niall-horan/slow-hands-single/slow-hands/TRXgqVhPXtj3k9g?shareImp=true", + "isSeed": false, + "allowStartStationFromTrack": true, + "allowShareTrack": true, + "allowBuyTrack": true, + "allowTiredOfTrack": true, + "allowSkipTrackWithoutLimit": false, + "allowSkip": true, + "allowFeedback": true, + "composerName": "", + "artistSeoToken": "niall-horan/AR3cxZc3P2dllcq", + "albumSeoToken": "niall-horan/slow-hands-single/ALjcm3n766qqcKZ", + "isCompilation": false, + "amazonUrl": "https://www.amazon.com/gp/search/?index=music&field-artist=Niall+Horan&field-title=Slow+Hands+%28Single%29&tag=wwwpandoracom-20", + "amazonDigitalAsin": "B071KHGZVJ", + "albumAmazonDigitalAsin": "B072KQKMRL", + "itunesUrl": "https://itunes.apple.com/album/slow-hands/id1230745029?i=1230745661&uo=5&at=11l3Hh&app=itunes", + "isFeatured": false, + "isBookmarked": false, + "adUrls": { + "flexSkipAdUrl": "https://adserver.pandora.com/haymaker/api/v1/serve/?slot=FLEX_SKIP&targeting=a11%3D10,15,22,27,6%3Baa%3D0%3Bab%3D100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88%3Bag%3D24%3Bapp%3D%3Bclean%3D0%3Bco%3D18039%3Bcon%3D%3Bd1%3D3%3Bd2%3D73%3Bd3%3D154%3Bd4%3D1748,1750,1881%3Bd8%3D0%3Bdma%3D588%3Bet%3D2%3Bfam%3D-1%3Bgcat%3DG1473%3Bgenre%3Dlatin%3Bgnd%3D1%3Bhhi%3D0%3Bhisp%3D0%3Bhours%3D0%3Bindex%3D__INDEX__%3Binteraction%3Dskip_limit%3Bmc%3D%3Bmodel%3D%3Bmsa%3D%3Bp%3D1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964%3Bp13%3D2%3Bp8%3D2%3Bst%3DIN%3Bstation%3D%3Bt4%3D257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906%3Buq%3Dbf756e84b44d3c48c4b2fc493aa56950%3Bvx%3D%3Bzip%3D46516&l=joa5tbfs7a2n4nczsl7tilo4nhtest7atn4rdri&zone=prod.__ZONE__&site=default&env=prod&assetType=COACHMARK&ppid=bf756e84b44d3c48c4b2fc493aa56950&c=__CACHEBUST__", + "flexReplayAdUrl": "https://adserver.pandora.com/haymaker/api/v1/serve/?slot=FLEX_REPLAY&targeting=a11%3D10,15,22,27,6%3Baa%3D0%3Bab%3D100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88%3Bag%3D24%3Bapp%3D%3Bclean%3D0%3Bco%3D18039%3Bcon%3D%3Bd1%3D3%3Bd2%3D73%3Bd3%3D154%3Bd4%3D1748,1750,1881%3Bd8%3D0%3Bdma%3D588%3Bet%3D2%3Bfam%3D-1%3Bgcat%3DG1473%3Bgenre%3Dlatin%3Bgnd%3D1%3Bhhi%3D0%3Bhisp%3D0%3Bhours%3D0%3Bindex%3D__INDEX__%3Binteraction%3Dreplay%3Bmc%3D%3Bmodel%3D%3Bmsa%3D%3Bp%3D1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964%3Bp13%3D2%3Bp8%3D2%3Bst%3DIN%3Bstation%3D%3Bt4%3D257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906%3Buq%3Dbf756e84b44d3c48c4b2fc493aa56950%3Bvx%3D%3Bzip%3D46516&l=5bweg5xwsbe2vaed6kw5ujas4q5viuxyjfrzyyq&zone=prod.__ZONE__&site=default&env=prod&assetType=COACHMARK&ppid=bf756e84b44d3c48c4b2fc493aa56950&c=__CACHEBUST__", + "flexThumbsDownAdUrl": "https://adserver.pandora.com/haymaker/api/v1/serve/?slot=FLEX_THUMBS_DOWN&targeting=a11%3D10,15,22,27,6%3Baa%3D0%3Bab%3D100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88%3Bag%3D24%3Bapp%3D%3Bclean%3D0%3Bco%3D18039%3Bcon%3D%3Bd1%3D3%3Bd2%3D73%3Bd3%3D154%3Bd4%3D1748,1750,1881%3Bd8%3D0%3Bdma%3D588%3Bet%3D2%3Bfam%3D-1%3Bgcat%3DG1473%3Bgenre%3Dlatin%3Bgnd%3D1%3Bhhi%3D0%3Bhisp%3D0%3Bhours%3D0%3Bindex%3D__INDEX__%3Binteraction%3Dskip_limit%3Bmc%3D%3Bmodel%3D%3Bmsa%3D%3Bp%3D1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964%3Bp13%3D2%3Bp8%3D2%3Bst%3DIN%3Bstation%3D%3Bt4%3D257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906%3Buq%3Dbf756e84b44d3c48c4b2fc493aa56950%3Bvx%3D%3Bzip%3D46516&l=fywri4r7i35owrp4hs3v6ztzt5nulofdaepntry&zone=prod.__ZONE__&site=default&env=prod&assetType=COACHMARK&ppid=bf756e84b44d3c48c4b2fc493aa56950&c=__CACHEBUST__", + "nowPlayingStationAdUrl": "https://pubads.g.doubleclick.net/gampad/adx?iu=/4204/pand.default/prod.radio&t=a11%3D10,15,22,27,6%26aa%3D0%26ab%3D100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88%26abx%3D654,1454,983,487,484,632,985,448,631,1431,1289,424,485,646,1193,1412,1158,402,989,1156,906,907,1414,429,984,1118,1159%26ag%3D24%26artist%3DG1473%26async%3D0%26clean%3D0%26co%3D18039%26comped%3D0%26d1%3D3%26d2%3D73%26d3%3D154%26d4%3D1748,1750,1881%26d8%3D0%26dma%3D588%26dse%3D0%26et%3D2%26exp%3D0%26fam%3D-1%26fb%3D0%26gcat%3DG1473%26gnd%3D1%26hhi%3D0%26hisp%3D0%26hours%3D0%26iat%3D0%26index%3D__INDEX__%26interaction%3D__ACTION__%26l%3Dhvy5cswdlmirfmg5lrj5tw2qw2kgfjopmkutnqy%26p%3D1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964%26p13%3D2%26p8%3D2%26prg%3D1%26st%3DIN%26t4%3D257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906%26uq%3Dbf756e84b44d3c48c4b2fc493aa56950%26zip%3D46516&ppid=bf756e84b44d3c48c4b2fc493aa56950&sz=2000x2%7C300x250%7C300x600&c=__CACHEBUST__", + "nowPlayingStationAdUnit": "/4204/pand.default/prod.radio", + "nowPlayingStationAdTargeting": "a11=10,15,22,27,6;aa=0;ab=100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88;abx=654,1454,983,487,484,632,985,448,631,1431,1289,424,485,646,1193,1412,1158,402,989,1156,906,907,1414,429,984,1118,1159;ag=24;artist=G1473;async=0;clean=0;co=18039;comped=0;d1=3;d2=73;d3=154;d4=1748,1750,1881;d8=0;dma=588;dse=0;et=2;exp=0;fam=-1;fb=0;gcat=G1473;gnd=1;hhi=0;hisp=0;hours=0;iat=0;index=__INDEX__;interaction=__ACTION__;l=hvy5cswdlmirfmg5lrj5tw2qw2kgfjopmkutnqy;p=1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964;p13=2;p8=2;prg=1;st=IN;t4=257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906;uq=bf756e84b44d3c48c4b2fc493aa56950;zip=46516", + "backstageAdUrl": "https://pubads.g.doubleclick.net/gampad/adx?iu=/4204/pand.default/prod.backstage&t=a11%3D10,15,22,27,6%26aa%3D0%26ab%3D100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88%26abx%3D654,1454,983,487,484,632,985,448,631,1431,1289,424,485,646,1193,1412,1158,402,989,1156,906,907,1414,429,984,1118,1159%26ag%3D24%26artist%3DG1473%26async%3D0%26clean%3D0%26co%3D18039%26comped%3D0%26d1%3D3%26d2%3D73%26d3%3D154%26d4%3D1748,1750,1881%26d8%3D0%26dma%3D588%26dse%3D0%26et%3D2%26exp%3D0%26fam%3D-1%26fb%3D0%26gcat%3DG1473%26gnd%3D1%26hhi%3D0%26hisp%3D0%26hours%3D0%26iat%3D0%26index%3D__INDEX__%26interaction%3D__ACTION__%26l%3Duhymlajwxw3z4lp4d2novvuiivbwfgqqgtf6dqq%26p%3D1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964%26p13%3D2%26p8%3D2%26prg%3D1%26st%3DIN%26t4%3D257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906%26uq%3Dbf756e84b44d3c48c4b2fc493aa56950%26zip%3D46516&ppid=bf756e84b44d3c48c4b2fc493aa56950&sz=2000x2%7C300x250%7C300x600&c=__CACHEBUST__", + "backstageAdUnit": "/4204/pand.default/prod.backstage", + "backstageAdTargeting": "a11=10,15,22,27,6;aa=0;ab=100,120,122,125,129,131,133,136,137,140,141,144,146,148,151,154,156,158,163,62,69,72,88;abx=654,1454,983,487,484,632,985,448,631,1431,1289,424,485,646,1193,1412,1158,402,989,1156,906,907,1414,429,984,1118,1159;ag=24;artist=G1473;async=0;clean=0;co=18039;comped=0;d1=3;d2=73;d3=154;d4=1748,1750,1881;d8=0;dma=588;dse=0;et=2;exp=0;fam=-1;fb=0;gcat=G1473;gnd=1;hhi=0;hisp=0;hours=0;iat=0;index=__INDEX__;interaction=__ACTION__;l=uhymlajwxw3z4lp4d2novvuiivbwfgqqgtf6dqq;p=1,103,110,116,13,135,140,158,21,260,31,33,37,4,533,551,570,578,585,655,667,677,8,964;p13=2;p8=2;prg=1;st=IN;t4=257,334,335,337,358,363,396,398,447,469,491,508,514,556,562,565,573,591,592,600,613,614,673,690,696,709,778,796,804,847,848,857,858,906;uq=bf756e84b44d3c48c4b2fc493aa56950;zip=46516" + }, + "songTitle": "Slow Hands", + "musicId": "S10296263", + "trackType": "Track", + "pandoraId": "TR:10296263", + "trackToken": "PTlqhbC-55drVs1yFGsa4D5UPmVsZ9z-F1Oa1wNdpYk2_Q0RDUKG3_U3vDcuVW3DPa8Lf2OA5ToR4nulgKysBkw", + "identity": "41561d0348209a43fd397f2baa1b41ad", + "trackLength": 188, + "rating": 0, + "stationId": "3793312577613735337", + "fileGain": "-3.75", + "songDetailURL": "https://www.pandora.com/artist/niall-horan/slow-hands-single/slow-hands/TRXgqVhPXtj3k9g", + "trackSeoToken": "niall-horan/slow-hands-single/slow-hands/TRXgqVhPXtj3k9g", + "audioURL": "https://audio-ch1-t1-2-v4v6.pandora.com/access/?version=5&lid=112207273&token=yxyJ0D%2FlHwnMbB57N28oKHX1sPFTQnipfbm684tmEwdU%2F41wUlQRlBThmBzkSmT3PXzMWRcq2XDnttLJqd3ORPvfmmpzoiMlTZ2mGogkZugzyMm6YBFNSlDXZkige4m6xhrbrj95OWs9rbYl8MM4jMoQ4NmO7erq4rqo96wIFqUQRJh82jOzKvCEcE1wVn0IUOFipusC9G%2BCQyP4O8%2BO7ZoMfyqUJ%2Fcd5tbP5VzuyIyVNM%2BqS4dDhM1U82ZNsBVpr5WWzO0kFHD5EnMiY9CmexeVqu5C6ikpkl9Z46r9sSWzsASHlQl9FkQ5IIQ64YYIyebVYbhpWAXUjqoK4pOA8A%3D%3D", + "rights": [ + "replayRequiresReward", + "allowSkipAfterLimit", + "showReplayButton", + "allowReplay" + ], + "audioEncoding": "aacplus", + "audioTokenId": "jp6ta2492", + "audioReceiptURL": "https://audio-ch1-t1-2-v4v6.pandora.com/receipt/?version=5&receiptId=yxyJ0D%2FlHwnRoreL923tJg9zb%2BZz9reD&token=yxyJ0D%2FlHwnMbB57N28oKHX1sPFTQnipfbm684tmEwdU%2F41wUlQRlBThmBzkSmT3PXzMWRcq2XDnttLJqd3ORPvfmmpzoiMlTZ2mGogkZugzyMm6YBFNSlDXZkige4m6xhrbrj95OWs9rbYl8MM4jMoQ4NmO7erq4rqo96wIFqUQRJh82jOzKvCEcE1wVn0IUOFipusC9G%2BCQyP4O8%2BO7ZoMfyqUJ%2Fcd5tbP5VzuyIyVNM%2BqS4dDhM1U82ZNsBVpr5WWzO0kFHD5EnMiY9CmexeVqu5C6ikpkl9Z46r9sSWzsASHlQl9FkQ5IIQ64YYIyebVYbhpWAXUjqoK4pOA8A%3D%3D", + "audioSkipUrl": "https://audio-ch1-t1-2-v4v6.pandora.com/skip/?version=5&token=yxyJ0D%2FlHwnMbB57N28oKHX1sPFTQnipfbm684tmEwdU%2F41wUlQRlBThmBzkSmT3PXzMWRcq2XDnttLJqd3ORPvfmmpzoiMlTZ2mGogkZugzyMm6YBFNSlDXZkige4m6xhrbrj95OWs9rbYl8MM4jMoQ4NmO7erq4rqo96wIFqUQRJh82jOzKvCEcE1wVn0IUOFipusC9G%2BCQyP4O8%2BO7ZoMfyqUJ%2Fcd5tbP5VzuyIyVNM%2BqS4dDhM1U82ZNsBVpr5WWzO0kFHD5EnMiY9CmexeVqu5C6ikpkl9Z46r9sSWzsASHlQl9FkQ5IIQ64YYIyebVYbhpWAXUjqoK4pOA8A%3D%3D", + "artistName": "Niall Horan", + "artistMusicId": "R713137", + "artistArt": [ + { + "url": "https://mediaserver-cont-sv5-2-v4v6.pandora.com/images/public/rovi/portrait/7/4/5/4/MN0002854547_200W.jpg", + "size": 200 + }, + { + "url": "https://mediaserver-cont-dc6-1-v4v6.pandora.com/images/public/rovi/portrait/7/4/5/4/MN0002854547_640W.jpg", + "size": 640 + }, + { + "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/rovi/portrait/7/4/5/4/MN0002854547.jpg", + "size": 1080 + } + ], + "artistDetailURL": "https://www.pandora.com/artist/niall-horan/AR3cxZc3P2dllcq", + "albumTitle": "Slow Hands (Single)", + "albumArt": [ + { + "url": "https://mediaserver-cont-ch1-1-v4v6.pandora.com/images/public/int/9/7/2/1/00602557661279_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://cont-1.p-cdn.com/images/public/int/9/7/2/1/00602557661279_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/9/7/2/1/00602557661279_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://mediaserver-cont-ch1-1-v4v6.pandora.com/images/public/int/9/7/2/1/00602557661279_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://cont-1.p-cdn.com/images/public/int/9/7/2/1/00602557661279_1080W_1080H.jpg", + "size": 1080 + } + ], + "albumDetailURL": "https://www.pandora.com/artist/niall-horan/slow-hands-single/ALjcm3n766qqcKZ", + "trackKey": { + "trackId": "S10296263", + "trackType": "Track", + "spinId": "3f3366e3-7775-44bc-b5d9-c363c9d865ed" + } + } + ], + "listenerQualifiesForUpsell": true, + "isBingeSkipping": false + } diff --git a/rest/search.rst b/rest/search.rst new file mode 100644 index 0000000..f978888 --- /dev/null +++ b/rest/search.rst @@ -0,0 +1,168 @@ +.. _rest-search: + +====== +Search +====== + +.. _rest-v1-search-getStationRecommendations: + +Get Station Recommendations +=========================== + +:Endpoint: /v1/search/getStationRecommendations + +Request +------- +.. code:: json + + {} + +Response +-------- +.. code:: json + + { + "artists": [ + { + "name": "Halsey", + "musicId": "R450147", + "pandoraId": "AR:450147", + "detailUrl": "https://www.pandora.com/artist/halsey/ARVjV9gbVJ7cjxq", + "art": [ + { + "url": "https://mediaserver-cont-sv5-2-v4v6.pandora.com/images/public/int/8/7/5/8/00602557708578_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/8/7/5/8/00602557708578_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/int/8/7/5/8/00602557708578_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/8/7/5/8/00602557708578_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://mediaserver-cont-ch1-2-v4v6.pandora.com/images/public/int/8/7/5/8/00602557708578_1080W_1080H.jpg", + "size": 1080 + } + ], + "likelyMatch": false, + "isComposer": false, + "isComedy": false, + "listenerCount": 2660756 + } + ], + "genreStations": [ + { + "name": "Dance Pop", + "token": "dance-pop", + "musicId": "G540", + "pandoraId": "GE:540", + "description": "Dance Pop features all the biggest hits and remixes from today's biggest stars, plus dance favorites you know and love. Check it out when you need a burst of energy!", + "art": [ + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/8/8/1/7/800027188_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://cont-1.p-cdn.com/images/public/int/8/8/1/7/800027188_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://mediaserver-cont-sv5-2-v4v6.pandora.com/images/public/int/8/8/1/7/800027188_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/int/8/8/1/7/800027188_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/int/8/8/1/7/800027188_1080W_1080H.jpg", + "size": 1080 + } + ], + "headerArt": [ + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/composite/genre_station_headers/5/4/0/genre_station_header_640x480_G540.jpg", + "size": 640 + } + ], + "listenerCount": 6810051, + "score": 100, + "isRedirect": false, + "isComedy": false, + "sampleTracks": [ + { + "musicId": "S2178312", + "pandoraId": "TR:2178312", + "songTitle": "S&M", + "albumTitle": "Loud (Explicit)", + "artistName": "Rihanna", + "artistSeoToken": "rihanna/ARZP3bqJrVgXfp4", + "artistDetailUrl": "https://www.pandora.com/artist/rihanna/ARZP3bqJrVgXfp4", + "trackSeoToken": "rihanna/loud-explicit/s-m/TRvc2f7v79JzJgK", + "trackDetailUrl": "https://www.pandora.com/artist/rihanna/loud-explicit/s-m/TRvc2f7v79JzJgK", + "albumSeoToken": "rihanna/loud-explicit/ALpt5747bcZjxX4", + "sampleUrl": "https://audio-ssl.itunes.apple.com/apple-assets-us-std-000001/Music/cd/fd/79/mzm.mewznlkh.aac.p.m4a", + "amazonUrl": "https://www.amazon.com/gp/search/?index=music&field-artist=Rihanna&field-title=Loud+%28Explicit%29&tag=wwwpandoracom-20", + "amazonDigitalAsin": "B005I0BR7C", + "albumAmazonDigitalAsin": "B005I0BR0E", + "itunesUrl": "http://itunes.apple.com/album/s-m/id417296814?i=417296825&uo=5&at=11l3Hh&app=itunes", + "trackNum": 1, + "discNum": 1, + "trackLength": 243, + "albumArt": [ + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/8/8/1/7/800027188_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/int/8/8/1/7/800027188_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/int/8/8/1/7/800027188_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/int/8/8/1/7/800027188_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://cont-1.p-cdn.com/images/public/int/8/8/1/7/800027188_1080W_1080H.jpg", + "size": 1080 + } + ] + } + ], + "sampleTracksPandoraId": "SS:18245:540", + "sampleArtists": [ + { + "musicId": "R169185", + "pandoraId": "AR:169185", + "name": "Rihanna", + "art": [ + { + "url": "https://cont-2.p-cdn.com/images/public/rovi/portrait/8/8/1/7/MN0000367188_200W.jpg", + "size": 200 + }, + { + "url": "https://mediaserver-cont-ch1-1-v4v6.pandora.com/images/public/rovi/portrait/8/8/1/7/MN0000367188_640W.jpg", + "size": 640 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/rovi/portrait/8/8/1/7/MN0000367188.jpg", + "size": 1080 + } + ], + "seoToken": "rihanna/ARZP3bqJrVgXfp4", + "detailUrl": "https://www.pandora.com/artist/rihanna/ARZP3bqJrVgXfp4" + } + ] + } + ] + } \ No newline at end of file diff --git a/rest/stations.rst b/rest/stations.rst index 8d2324b..906978b 100644 --- a/rest/stations.rst +++ b/rest/stations.rst @@ -24,7 +24,7 @@ Response .. code:: json { - "totalStations": 2, + "totalStations": 1, "sortedBy": "lastPlayedTime", "index": 0, "stations": [ @@ -120,59 +120,544 @@ Response }, "creatorWebname": "example", "artId": "images/public/int/9/2/0/5/634904045029" - }, - { - "stationId": "12345", - "stationFactoryPandoraId": "SF:12345:0", - "pandoraId": "TT:0", - "name": "Thumbprint Radio", - "description": "Music inspired by your 999 thumbs from across all your stations.", - "art": [ - { - "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/devicead/t/r/a/m/daartpralbumart_90W_90H.jpg", - "size": 90 - }, - { - "url": "https://cont-2.p-cdn.com/images/public/devicead/t/r/a/m/daartpralbumart_130W_130H.jpg", - "size": 130 - }, - { - "url": "https://mediaserver-cont-dc6-1-v4v6.pandora.com/images/public/devicead/t/r/a/m/daartpralbumart_500W_500H.jpg", - "size": 500 - } - ], - "dateCreated": "2017-10-27T20:10:33.202-07:00", - "lastPlayed": "2017-10-27T21:36:04.426-07:00", - "totalPlayTime": 99999, - "isNew": false, - "allowDelete": true, - "allowRename": false, - "allowEditDescription": false, - "allowAddSeed": false, - "isShared": false, - "isTransformAllowed": false, - "isOnDemandEditorialStation": false, - "isAdvertiserStation": false, - "canShuffleStation": false, - "canAutoshare": true, - "advertisingKey": "", - "isArtistMessagesEnabled": false, - "isThumbprint": true, - "thumbprintThumbCount": 999, - "thumbprintProcessSkips": true, - "thumbprintShareArt": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/devicead/t/r/a/m/daartprfbalbumart_1200W_630H.jpg", - "shareName": "example's Thumbprint Radio", - "isShuffle": false, - "genre": [], - "adkv": { - "artist": "", - "genre": "thumbprintradio", - "clean": "0", - "gcat": "thumbprintradio" - }, - "creatorWebname": "example", - "artId": "images/public/devicead/t/r/a/m/daartpralbumart", - "dominantColor": "0c81c6" } ] } + +.. _rest-v1-station-trackStarted: + +Track Started +============= + +:Endpoint: /v1/station/trackStarted + +Request +------- +.. code:: json + + { + "trackToken": "PGFM66cl6W77Vs1yFGsa4D5KjNhU3GlaT1Oa1wNdpYk2_Q0RDUKG3_c0_PX7KYP55a8Lf2OA5ToT025KvGWH-Eg" + } + +Response +-------- +.. code:: json + + { + "updateFacebookInfo": false + } + +.. _rest-v1-station-playbackPaused: + +Playback Paused +=============== + +:Endpoint: /v1/station/playbackPaused + +Request +------- +.. code:: json + + { + "sync": false + } + +Response +-------- +.. code:: json + + {} + +.. _rest-v1-station-createStation: + +Create Station +============== + +:Endpoint: /v1/station/createStation + +Request +------- +.. code:: json + + { + "stationCode": "mcR750856", + "stationName": "", + "searchQuery": "test", + "pandoraId": null, + "creativeId": null, + "lineId": null, + "createionSource": null, + } + +Response +-------- +.. code:: json + + { + "stationId": "3815417889522984361", + "stationFactoryPandoraId": "SF:16722:750856", + "pandoraId": "ST:0:3815417889522984361", + "name": "Tee Grizzley Radio", + "art": [ + { + "url": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://mediaserver-cont-ch1-1-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_1080W_1080H.jpg", + "size": 1080 + } + ], + "dateCreated": "2017-12-04T16:26:05.041-08:00", + "isNew": true, + "allowDelete": true, + "allowRename": true, + "allowEditDescription": true, + "allowAddSeed": true, + "isShared": false, + "isTransformAllowed": false, + "isOnDemandEditorialStation": false, + "isAdvertiserStation": false, + "canShuffleStation": true, + "canAutoshare": true, + "advertisingKey": "", + "isArtistMessagesEnabled": true, + "isThumbprint": false, + "isShuffle": false, + "genre": [ + "Rap / Hip-Hop" + ], + "genreSponsorship": "R750856", + "adGenre": "electronica", + "antiTarget": false, + "initialSeed": { + "musicId": "R750856", + "pandoraId": "AR:750856", + "artist": { + "artistName": "Tee Grizzley", + "isComposer": false, + "isComedy": false, + "artistDetailUrl": "https://www.pandora.com/artist/tee-grizzley/ARpZvrqrjftKpcm" + }, + "listenerCount": 899699, + "seoToken": "tee-grizzley/ARpZvrqrjftKpcm", + "art": [ + { + "url": "https://mediaserver-cont-ch1-2-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/int/4/4/6/4/814908024644_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://mediaserver-cont-dc6-1-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/int/4/4/6/4/814908024644_1080W_1080H.jpg", + "size": 1080 + } + ] + }, + "adkv": { + "artist": "R750856", + "genre": "electronica", + "clean": "0", + "gcat": "R750856" + }, + "creatorWebname": "your-username", + "artId": "images/public/int/4/4/6/4/814908024644", + "dominantColor": "b12121" + } + +.. _rest-v1-station-shuffle: + +Shuffle +======= + +:Endpoint: /v1/station/shuffle + +Request +------- +.. code:: json + + {} + +Response +-------- +.. code:: json + + { + "stationId": "94498720962323881", + "stationFactoryPandoraId": "SF:21332:0:94498720962323881", + "pandoraId": "ST:0:94498720962323881", + "name": "Shuffle", + "art": [ + { + "url": "https://www.pandora.com/img/shuffle_art_90W_90H.png", + "size": 90 + }, + { + "url": "https://www.pandora.com/img/shuffle_art_130W_130H.png", + "size": 130 + }, + { + "url": "https://www.pandora.com/img/shuffle_art_500W_500H.png", + "size": 500 + }, + { + "url": "https://www.pandora.com/img/shuffle_art_600W_600H.png", + "size": 600 + }, + { + "url": "https://www.pandora.com/img/shuffle_art_640W_640H.png", + "size": 640 + }, + { + "url": "https://www.pandora.com/img/shuffle_art_1080W_1080H.png", + "size": 1080 + } + ], + "dateCreated": "2009-04-29T18:11:53.151-07:00", + "isNew": false, + "allowDelete": false, + "allowRename": false, + "allowEditDescription": false, + "allowAddSeed": false, + "isShared": false, + "isTransformAllowed": false, + "isOnDemandEditorialStation": false, + "isAdvertiserStation": false, + "canShuffleStation": false, + "canAutoshare": true, + "advertisingKey": "", + "isArtistMessagesEnabled": true, + "isThumbprint": false, + "isShuffle": true, + "shuffleStationIds": [ + "266232033420667434533", + "2378131011990553468169", + "21436172367947969449", + "3568413019964799131" + ], + "genre": [], + "adkv": { + "artist": "R10681", + "genre": "none", + "clean": "0", + "gcat": "none" + }, + "creatorWebname": "your-username", + "dominantColor": "c34b75" + } + +.. _rest-v1-station-getStationDetails: + +Get Station Details +=================== + +:Endpoint: /v1/station/getStationDetails + +Request +------- +.. code:: json + + { + "stationId": "3815417889522984361", + "isCurrentStation": true + } + +Response +-------- +.. code:: json + + { + "seeds": [ + { + "musicId": "R750856", + "pandoraId": "AR:750856", + "artist": { + "artistName": "Tee Grizzley", + "isComposer": false, + "isComedy": false, + "artistDetailUrl": "https://www.pandora.com/artist/tee-grizzley/ARpZvrqrjftKpcm" + }, + "listenerCount": 899699, + "seoToken": "tee-grizzley/ARpZvrqrjftKpcm", + "art": [ + { + "url": "https://mediaserver-cont-ch1-1-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://mediaserver-cont-sv5-2-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/int/4/4/6/4/814908024644_1080W_1080H.jpg", + "size": 1080 + } + ] + } + ], + "positiveFeedbackCount": 0, + "negativeFeedbackCount": 0, + "stationId": "3815417889522984361", + "stationFactoryPandoraId": "SF:16722:750856", + "pandoraId": "ST:0:3815417889522984361", + "name": "Tee Grizzley Radio", + "art": [ + { + "url": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://cont-1.p-cdn.com/images/public/int/4/4/6/4/814908024644_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://mediaserver-cont-dc6-1-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://mediaserver-cont-ch1-1-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/int/4/4/6/4/814908024644_1080W_1080H.jpg", + "size": 1080 + } + ], + "dateCreated": "2017-12-04T16:26:05.041-08:00", + "lastPlayed": "2017-12-04T16:26:05.519-08:00", + "isNew": false, + "allowDelete": true, + "allowRename": true, + "allowEditDescription": true, + "allowAddSeed": true, + "isShared": false, + "isTransformAllowed": false, + "isOnDemandEditorialStation": false, + "isAdvertiserStation": false, + "canShuffleStation": true, + "canAutoshare": true, + "advertisingKey": "", + "isArtistMessagesEnabled": true, + "isThumbprint": false, + "isShuffle": false, + "genre": [ + "Rap / Hip-Hop" + ], + "genreSponsorship": "R750856", + "adGenre": "electronica", + "antiTarget": false, + "initialSeed": { + "musicId": "R750856", + "pandoraId": "AR:750856", + "artist": { + "artistName": "Tee Grizzley", + "isComposer": false, + "isComedy": false, + "artistDetailUrl": "https://www.pandora.com/artist/tee-grizzley/ARpZvrqrjftKpcm" + }, + "listenerCount": 899699, + "seoToken": "tee-grizzley/ARpZvrqrjftKpcm", + "art": [ + { + "url": "https://mediaserver-cont-ch1-2-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://mediaserver-cont-dc6-1-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/int/4/4/6/4/814908024644_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/int/4/4/6/4/814908024644_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/int/4/4/6/4/814908024644_1080W_1080H.jpg", + "size": 1080 + } + ] + }, + "adkv": { + "artist": "R750856", + "genre": "electronica", + "clean": "0", + "gcat": "R750856" + }, + "creatorWebname": "your-username", + "artId": "images/public/int/4/4/6/4/814908024644", + "dominantColor": "b12121" + } + +.. _rest-v1-station-addFeedback: + +Add Feedback +============ + +:Endpoint: /v1/station/addFeedback + +Request +------- +.. code:: json + + { + "trackToken": "PWqWRL10lu3_Vs1yFGsa4D5UPmVsZ9z-F1Oa1wNdpYk2_Q0RDUKG3_U3vDcuVW3DP4NKGhYA6ecO_SMZISxwpog", + "isPositive": false + } + +Response +-------- +.. code:: json + + { + "feedbackId": "6192453069559637", + "isPositive": false, + "stationId": "3793312577613735337", + "stationName": "Pop 2017 Radio", + "musicId": "S5582987", + "pandoraId": "TR:5582987", + "songTitle": "All Time Low", + "albumTitle": "The Human Condition (Explicit)", + "artistName": "Jon Bellion", + "artistSeoToken": "jon-bellion/ARZvh6pgth6qc64", + "artistDetailUrl": "https://www.pandora.com/artist/jon-bellion/ARZvh6pgth6qc64", + "trackSeoToken": "jon-bellion/human-condition-explicit/all-time-low/TRm7mZKXfxpwK76", + "trackDetailUrl": "https://www.pandora.com/artist/jon-bellion/human-condition-explicit/all-time-low/TRm7mZKXfxpwK76", + "albumSeoToken": "jon-bellion/human-condition-explicit/ALZrKqJ9dKkvkmX", + "sampleUrl": "https://audio-ssl.itunes.apple.com/apple-assets-us-std-000001/AudioPreview18/v4/83/f6/89/83f68945-835b-be1f-5b02-ef153669ef84/mzaf_7005711340359546106.plus.aac.p.m4a", + "amazonUrl": "https://www.amazon.com/gp/search/?index=music&field-artist=Jon+Bellion&field-title=The+Human+Condition+%28Explicit%29&tag=wwwpandoracom-20", + "amazonDigitalAsin": "B01F9W9CZC", + "albumAmazonDigitalAsin": "B01F9W9A5O", + "itunesUrl": "http://itunes.apple.com/album/all-time-low/id1111414736?i=1111414908&uo=5&at=11l3Hh&app=itunes", + "trackNum": 3, + "discNum": 1, + "trackLength": 217, + "albumArt": [ + { + "url": "https://mediaserver-cont-sv5-3-v4v6.pandora.com/images/public/int/4/5/0/8/00602547858054_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://mediaserver-cont-ch1-1-v4v6.pandora.com/images/public/int/4/5/0/8/00602547858054_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://mediaserver-cont-dc6-2-v4v6.pandora.com/images/public/int/4/5/0/8/00602547858054_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://cont-1.p-cdn.com/images/public/int/4/5/0/8/00602547858054_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://cont-1.p-cdn.com/images/public/int/4/5/0/8/00602547858054_1080W_1080H.jpg", + "size": 1080 + } + ] + } + +.. _rest-v1-station-getStationFeedback: + +Get Station Feedback +==================== + +:Endpoint: /v1/station/getStationFeedback + +Request +------- +.. code:: json + + { + "pageSize": 1, + "startIndex": 0, + "stationId": "3793312577613735337", + "positive": false + } + +Response +-------- +.. code:: json + + { + "total": 1, + "feedback": [ + { + "feedbackId": "6192453069559637", + "isPositive": false, + "stationId": "3793312577613735337", + "stationName": "Pop 2017 Radio", + "musicId": "S5582987", + "pandoraId": "TR:5582987", + "songTitle": "All Time Low", + "albumTitle": "The Human Condition (Explicit)", + "artistName": "Jon Bellion", + "artistSeoToken": "jon-bellion/ARZvh6pgth6qc64", + "artistDetailUrl": "https://www.pandora.com/artist/jon-bellion/ARZvh6pgth6qc64", + "trackSeoToken": "jon-bellion/human-condition-explicit/all-time-low/TRm7mZKXfxpwK76", + "trackDetailUrl": "https://www.pandora.com/artist/jon-bellion/human-condition-explicit/all-time-low/TRm7mZKXfxpwK76", + "albumSeoToken": "jon-bellion/human-condition-explicit/ALZrKqJ9dKkvkmX", + "sampleUrl": "https://audio-ssl.itunes.apple.com/apple-assets-us-std-000001/AudioPreview18/v4/83/f6/89/83f68945-835b-be1f-5b02-ef153669ef84/mzaf_7005711340359546106.plus.aac.p.m4a", + "amazonUrl": "https://www.amazon.com/gp/search/?index=music&field-artist=Jon+Bellion&field-title=The+Human+Condition+%28Explicit%29&tag=wwwpandoracom-20", + "amazonDigitalAsin": "B01F9W9CZC", + "albumAmazonDigitalAsin": "B01F9W9A5O", + "itunesUrl": "http://itunes.apple.com/album/all-time-low/id1111414736?i=1111414908&uo=5&at=11l3Hh&app=itunes", + "trackNum": 3, + "discNum": 1, + "trackLength": 217, + "albumArt": [ + { + "url": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/int/4/5/0/8/00602547858054_90W_90H.jpg", + "size": 90 + }, + { + "url": "https://mediaserver-cont-ch1-2-v4v6.pandora.com/images/public/int/4/5/0/8/00602547858054_130W_130H.jpg", + "size": 130 + }, + { + "url": "https://cont-2.p-cdn.com/images/public/int/4/5/0/8/00602547858054_500W_500H.jpg", + "size": 500 + }, + { + "url": "https://mediaserver-cont-sv5-1-v4v6.pandora.com/images/public/int/4/5/0/8/00602547858054_640W_640H.jpg", + "size": 640 + }, + { + "url": "https://mediaserver-cont-ch1-1-v4v6.pandora.com/images/public/int/4/5/0/8/00602547858054_1080W_1080H.jpg", + "size": 1080 + } + ] + } + ] + } \ No newline at end of file -- cgit v1.2.3