Skip to content

Commit f3e3938

Browse files
committed
feat: add docs for details api routes
Signed-off-by: rajput-hemant <rajput.hemant2001@gmail.com>
1 parent 7532694 commit f3e3938

File tree

4 files changed

+14851
-5
lines changed

4 files changed

+14851
-5
lines changed

docs/details/album.md

Lines changed: 362 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,365 @@ order: 90
33
icon: stack
44
---
55

6-
## :construction: Work in progress
6+
# Album Details
7+
8+
!!! Note
9+
<https://jiosaavn.shuttleapp.rs> is only meant to demo the API and has rate-limiting enabled to minimise bandwidth consumption.
10+
It is recommended to deploy your own instance for personal use.
11+
!!!
12+
13+
## Album details by album ID
14+
15+
+++ Request
16+
17+
HTTP
18+
19+
```bash
20+
https://jiosaavn.shuttleapp.rs/album?id=25500145
21+
```
22+
23+
cURL
24+
25+
```bash
26+
curl -X GET 'https://jiosaavn.shuttleapp.rs/album?id=25500145' \
27+
-H 'content-type: application/json'
28+
```
29+
30+
+++ Response
31+
32+
```json
33+
{
34+
"status": "Success",
35+
"message": "✅ Album details fetched successfully!",
36+
"data": {
37+
"id": "25500145",
38+
"name": "Ram Siya Ram",
39+
"subtitle": "Sachet Tandon",
40+
"type": "album",
41+
"language": "hindi",
42+
"playCount": 0,
43+
"explicit": false,
44+
"year": 2021,
45+
"url": "https://www.jiosaavn.com/album/ram-siya-ram/cy9LsEw-pn0_",
46+
"image": [
47+
{
48+
"quality": "50x50",
49+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-50x50.jpg"
50+
},
51+
{
52+
"quality": "150x150",
53+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-150x150.jpg"
54+
},
55+
{
56+
"quality": "500x500",
57+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-500x500.jpg"
58+
}
59+
],
60+
"releaseDate": null,
61+
"artistMap": {
62+
"primaryArtists": [
63+
{
64+
"id": "3623110",
65+
"name": "Sachet Tandon",
66+
"role": "",
67+
"image": "https://c.saavncdn.com/artists/Sachet_Tandon_001_20191130070910_150x150.jpg",
68+
"type": "artist",
69+
"url": "https://www.jiosaavn.com/artist/sachet-tandon-songs/wVwhaAx3x6c_"
70+
}
71+
],
72+
"featuredArtists": [],
73+
"artists": [
74+
{
75+
"id": "3623110",
76+
"name": "Sachet Tandon",
77+
"role": "",
78+
"image": "https://c.saavncdn.com/artists/Sachet_Tandon_001_20191130070910_150x150.jpg",
79+
"type": "artist",
80+
"url": "https://www.jiosaavn.com/artist/sachet-tandon-songs/wVwhaAx3x6c_"
81+
}
82+
]
83+
},
84+
"songCount": 1,
85+
"copyrightText": "© 2021 Super Cassettes Industries Private Limited",
86+
"isDolbyContent": false,
87+
"songs": [
88+
{
89+
"id": "HLulXlir",
90+
"name": "Ram Siya Ram",
91+
"subtitle": "Sachet Tandon - Ram Siya Ram",
92+
"type": "song",
93+
"url": "https://www.jiosaavn.com/song/ram-siya-ram/OCQeXSxcXkE",
94+
"image": [
95+
{
96+
"quality": "50x50",
97+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-50x50.jpg"
98+
},
99+
{
100+
"quality": "150x150",
101+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-150x150.jpg"
102+
},
103+
{
104+
"quality": "500x500",
105+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-500x500.jpg"
106+
}
107+
],
108+
"language": "hindi",
109+
"year": 2021,
110+
"playCount": 61463043,
111+
"explicitContent": false,
112+
"listCount": 0,
113+
"listType": "",
114+
"list": "",
115+
"music": "Poonam Thakkar",
116+
"song": null,
117+
"albumId": "25500145",
118+
"album": "Ram Siya Ram",
119+
"label": "",
120+
"origin": "album",
121+
"isDolbyContent": false,
122+
"320kbps": true,
123+
"downloadUrl": "ID2ieOjCrwfgWvL5sXl4B1ImC5QfbsDyYJ+5/mMmphgKGwkNDtSkT/MwZwumWrWHz1fM9uHMbp+aUIGETZOvHRw7tS9a8Gtq",
124+
"albumUrl": "https://www.jiosaavn.com/album/ram-siya-ram/cy9LsEw-pn0_",
125+
"duration": 265,
126+
"rights": {
127+
"code": "0",
128+
"cacheable": "true",
129+
"delete_cached_object": "false",
130+
"reason": ""
131+
},
132+
"cacheState": "",
133+
"hasLyrics": true,
134+
"lyricsSnippet": "Lyrics",
135+
"starred": false,
136+
"copyrightText": "℗ 2021 Super Cassettes Industries Private Limited",
137+
"artistMap": {
138+
"primaryArtists": [
139+
{
140+
"id": "3623110",
141+
"name": "Sachet Tandon",
142+
"role": "primary_artists",
143+
"image": "https://c.saavncdn.com/artists/Sachet_Tandon_001_20191130070910_150x150.jpg",
144+
"type": "artist",
145+
"url": "https://www.jiosaavn.com/artist/sachet-tandon-songs/wVwhaAx3x6c_"
146+
}
147+
],
148+
"featuredArtists": [],
149+
"artists": [
150+
{
151+
"id": "9521286",
152+
"name": "Poonam Thakkar",
153+
"role": "music",
154+
"image": "",
155+
"type": "artist",
156+
"url": "https://www.jiosaavn.com/artist/poonam-thakkar-songs/K9zFVB-gAME_"
157+
},
158+
{
159+
"id": "3623110",
160+
"name": "Sachet Tandon",
161+
"role": "singer",
162+
"image": "https://c.saavncdn.com/artists/Sachet_Tandon_001_20191130070910_150x150.jpg",
163+
"type": "artist",
164+
"url": "https://www.jiosaavn.com/artist/sachet-tandon-songs/wVwhaAx3x6c_"
165+
},
166+
{
167+
"id": "461011",
168+
"name": "Shabbir Ahmed",
169+
"role": "lyricist",
170+
"image": "https://c.saavncdn.com/artists/Shabbir_Ahmed_150x150.jpg",
171+
"type": "artist",
172+
"url": "https://www.jiosaavn.com/artist/shabbir-ahmed-songs/CUgZ-dg1Y9w_"
173+
}
174+
]
175+
},
176+
"releaseDate": "2021-02-22",
177+
"trillerAvailable": false,
178+
"lyricsId": ""
179+
}
180+
]
181+
}
182+
}
183+
```
184+
185+
+++
186+
187+
| Query Parameter | Description | Required |
188+
| :-----------------------------------: | :---------: | :------------------------------------: |
189+
| [!badge variant="contrast" text="id"] | Album ID | [!badge variant="primary" text="True"] |
190+
191+
## Album details by link
192+
193+
+++ Request
194+
195+
HTTP
196+
197+
```bash
198+
https://jiosaavn.shuttleapp.rs/album?link=https://www.jiosaavn.com/album/ram-siya-ram/cy9LsEw-pn0_
199+
```
200+
201+
cURL
202+
203+
```bash
204+
curl -X GET 'https://jiosaavn.shuttleapp.rs/album?link=https://www.jiosaavn.com/album/ram-siya-ram/cy9LsEw-pn0_' \
205+
-H 'content-type: application/json'
206+
```
207+
208+
+++ Response
209+
210+
```json
211+
{
212+
"status": "Success",
213+
"message": "✅ Album details fetched successfully!",
214+
"data": {
215+
"id": "25500145",
216+
"name": "Ram Siya Ram",
217+
"subtitle": "Sachet Tandon",
218+
"type": "album",
219+
"language": "hindi",
220+
"playCount": 0,
221+
"explicit": false,
222+
"year": 2021,
223+
"url": "https://www.jiosaavn.com/album/ram-siya-ram/cy9LsEw-pn0_",
224+
"image": [
225+
{
226+
"quality": "50x50",
227+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-50x50.jpg"
228+
},
229+
{
230+
"quality": "150x150",
231+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-150x150.jpg"
232+
},
233+
{
234+
"quality": "500x500",
235+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-500x500.jpg"
236+
}
237+
],
238+
"releaseDate": null,
239+
"artistMap": {
240+
"primaryArtists": [
241+
{
242+
"id": "3623110",
243+
"name": "Sachet Tandon",
244+
"role": "",
245+
"image": "https://c.saavncdn.com/artists/Sachet_Tandon_001_20191130070910_150x150.jpg",
246+
"type": "artist",
247+
"url": "https://www.jiosaavn.com/artist/sachet-tandon-songs/wVwhaAx3x6c_"
248+
}
249+
],
250+
"featuredArtists": [],
251+
"artists": [
252+
{
253+
"id": "3623110",
254+
"name": "Sachet Tandon",
255+
"role": "",
256+
"image": "https://c.saavncdn.com/artists/Sachet_Tandon_001_20191130070910_150x150.jpg",
257+
"type": "artist",
258+
"url": "https://www.jiosaavn.com/artist/sachet-tandon-songs/wVwhaAx3x6c_"
259+
}
260+
]
261+
},
262+
"songCount": 1,
263+
"copyrightText": "© 2021 Super Cassettes Industries Private Limited",
264+
"isDolbyContent": false,
265+
"songs": [
266+
{
267+
"id": "HLulXlir",
268+
"name": "Ram Siya Ram",
269+
"subtitle": "Sachet Tandon - Ram Siya Ram",
270+
"type": "song",
271+
"url": "https://www.jiosaavn.com/song/ram-siya-ram/OCQeXSxcXkE",
272+
"image": [
273+
{
274+
"quality": "50x50",
275+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-50x50.jpg"
276+
},
277+
{
278+
"quality": "150x150",
279+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-150x150.jpg"
280+
},
281+
{
282+
"quality": "500x500",
283+
"link": "https://c.saavncdn.com/215/Ram-Siya-Ram-Hindi-2021-20210222031001-500x500.jpg"
284+
}
285+
],
286+
"language": "hindi",
287+
"year": 2021,
288+
"playCount": 61463043,
289+
"explicitContent": false,
290+
"listCount": 0,
291+
"listType": "",
292+
"list": "",
293+
"music": "Poonam Thakkar",
294+
"song": null,
295+
"albumId": "25500145",
296+
"album": "Ram Siya Ram",
297+
"label": "",
298+
"origin": "album",
299+
"isDolbyContent": false,
300+
"320kbps": true,
301+
"downloadUrl": "ID2ieOjCrwfgWvL5sXl4B1ImC5QfbsDyYJ+5/mMmphgKGwkNDtSkT/MwZwumWrWHz1fM9uHMbp+aUIGETZOvHRw7tS9a8Gtq",
302+
"albumUrl": "https://www.jiosaavn.com/album/ram-siya-ram/cy9LsEw-pn0_",
303+
"duration": 265,
304+
"rights": {
305+
"code": "0",
306+
"cacheable": "true",
307+
"delete_cached_object": "false",
308+
"reason": ""
309+
},
310+
"cacheState": "",
311+
"hasLyrics": true,
312+
"lyricsSnippet": "Lyrics",
313+
"starred": false,
314+
"copyrightText": "℗ 2021 Super Cassettes Industries Private Limited",
315+
"artistMap": {
316+
"primaryArtists": [
317+
{
318+
"id": "3623110",
319+
"name": "Sachet Tandon",
320+
"role": "primary_artists",
321+
"image": "https://c.saavncdn.com/artists/Sachet_Tandon_001_20191130070910_150x150.jpg",
322+
"type": "artist",
323+
"url": "https://www.jiosaavn.com/artist/sachet-tandon-songs/wVwhaAx3x6c_"
324+
}
325+
],
326+
"featuredArtists": [],
327+
"artists": [
328+
{
329+
"id": "9521286",
330+
"name": "Poonam Thakkar",
331+
"role": "music",
332+
"image": "",
333+
"type": "artist",
334+
"url": "https://www.jiosaavn.com/artist/poonam-thakkar-songs/K9zFVB-gAME_"
335+
},
336+
{
337+
"id": "3623110",
338+
"name": "Sachet Tandon",
339+
"role": "singer",
340+
"image": "https://c.saavncdn.com/artists/Sachet_Tandon_001_20191130070910_150x150.jpg",
341+
"type": "artist",
342+
"url": "https://www.jiosaavn.com/artist/sachet-tandon-songs/wVwhaAx3x6c_"
343+
},
344+
{
345+
"id": "461011",
346+
"name": "Shabbir Ahmed",
347+
"role": "lyricist",
348+
"image": "https://c.saavncdn.com/artists/Shabbir_Ahmed_150x150.jpg",
349+
"type": "artist",
350+
"url": "https://www.jiosaavn.com/artist/shabbir-ahmed-songs/CUgZ-dg1Y9w_"
351+
}
352+
]
353+
},
354+
"releaseDate": "2021-02-22",
355+
"trillerAvailable": false,
356+
"lyricsId": ""
357+
}
358+
]
359+
}
360+
}
361+
```
362+
363+
+++
364+
365+
| Query Parameter | Description | Required |
366+
| :-------------------------------------: | :------------------------------------: | :------------------------------------: |
367+
| [!badge variant="contrast" text="link"] | Album link from <https://jiosaavn.com> | [!badge variant="primary" text="True"] |

0 commit comments

Comments
 (0)