Browse Source

Example responses up to Top 10

pjc 4 years ago
parent
commit
3f2b9d36f5
5 changed files with 700 additions and 32 deletions
  1. 181
    5
      docs/forums.md
  2. 6
    6
      docs/index.md
  3. 116
    10
      docs/meta.md
  4. 93
    2
      docs/requests.md
  5. 304
    9
      docs/torrents.md

+ 181
- 5
docs/forums.md View File

13
 **Response**
13
 **Response**
14
 
14
 
15
 ```json
15
 ```json
16
-
16
+{
17
+    "status": "success",
18
+    "response": {
19
+        "categories": [
20
+            {
21
+                "categoryID": 5,
22
+                "categoryName": "Community",
23
+                "forums": [
24
+                    {
25
+                        "forumId": 4,
26
+                        "forumName": "General",
27
+                        "forumDescription": "",
28
+                        "numTopics": 5,
29
+                        "numPosts": 9,
30
+                        "lastPostId": 39,
31
+                        "lastAuthorId": 2,
32
+                        "lastPostAuthorName": "me",
33
+                        "lastTopicId": 30,
34
+                        "lastTime": "2020-05-27 17:53:57",
35
+                        "specificRules": [],
36
+                        "lastTopic": "Unplugging: Tune in, turn on, drop out",
37
+                        "read": false,
38
+                        "locked": false,
39
+                        "sticky": false
40
+                    },
41
+                    {
42
+                        "forumId": 13,
43
+                        "forumName": "Book Club",
44
+                        # etc.
45
+                    },
46
+                    # etc.
47
+                ]
48
+            },
49
+            {
50
+                "categoryID": 10,
51
+                "categoryName": "Help",
52
+                "forums": [
53
+                    {
54
+                        "forumId": 9,
55
+                        "forumName": "BitTorrent",
56
+                        # etc.
57
+                    },
58
+                    # etc.
59
+                ]
60
+            },
61
+            # etc.
62
+        ]
63
+    }
64
+}
17
 ```
65
 ```
18
 
66
 
19
 
67
 
31
 **Response**
79
 **Response**
32
 
80
 
33
 ```json
81
 ```json
34
-
82
+{
83
+    "status": "success",
84
+    "response": {
85
+        "forumName": "Bioinformatics",
86
+        "specificRules": [],
87
+        "currentPage": 1,
88
+        "pages": 1,
89
+        "threads": [
90
+            {
91
+                "topicId": 27,
92
+                "title": "Tidy Data: Developing in-house quality standards for original datasets",
93
+                "authorId": 2,
94
+                "authorName": "me",
95
+                "locked": false,
96
+                "sticky": false,
97
+                "postCount": 1,
98
+                "lastID": 36,
99
+                "lastTime": "2020-05-08 17:57:40",
100
+                "lastAuthorId": 2,
101
+                "lastAuthorName": "me",
102
+                "lastReadPage": 1,
103
+                "lastReadPostId": 36,
104
+                "read": true
105
+            },
106
+            {
107
+                "topicId": 26,
108
+                "title": "Microscopy image processing tools",
109
+                # etc.
110
+            },
111
+            # etc.
112
+        ]
113
+    }
114
+}
35
 ```
115
 ```
36
 
116
 
37
 
117
 
53
 **Response**
133
 **Response**
54
 
134
 
55
 ```json
135
 ```json
56
-
136
+{
137
+    "status": "success",
138
+    "response": {
139
+        "forumId": 10,
140
+        "forumName": "Website",
141
+        "threadId": 2,
142
+        "threadTitle": "Report broken site features",
143
+        "subscribed": false,
144
+        "locked": false,
145
+        "sticky": false,
146
+        "currentPage": 1,
147
+        "pages": 1,
148
+        "poll": null,
149
+        "posts": [
150
+            {
151
+                "postId": 2,
152
+                "addedTime": "2019-12-10 06:47:19",
153
+                "bbBody": "BBcode",
154
+                "body": "HTML",
155
+                "editedUserId": 1,
156
+                "editedTime": "2020-01-18 05:24:59",
157
+                "editedUsername": "ohm",
158
+                "author": {
159
+                    "authorId": 1,
160
+                    "authorName": "ohm",
161
+                    "paranoia": [
162
+                        "downloaded",
163
+                        "uploaded",
164
+                        "ratio",
165
+                        "lastseen",
166
+                        "requiredratio",
167
+                        "invitedcount",
168
+                        "artistsadded",
169
+                        "notifications",
170
+                        "torrentcomments+",
171
+                        "collages+",
172
+                        "collagecontribs+",
173
+                        "uploads+",
174
+                        "uniquegroups+",
175
+                        "perfectflacs+",
176
+                        "seeding+",
177
+                        "leeching+",
178
+                        "snatched+",
179
+                        "requestsfilled_list",
180
+                        "requestsfilled_count",
181
+                        "requestsfilled_bounty",
182
+                        "requestsvoted_list",
183
+                        "requestsvoted_count",
184
+                        "requestsvoted_bounty",
185
+                        "hide_donor_heart"
186
+                    ],
187
+                    "artist": false,
188
+                    "donor": true,
189
+                    "warned": false,
190
+                    "avatar": "",
191
+                    "enabled": true,
192
+                    "userTitle": null
193
+                }
194
+            },
195
+            {
196
+                "postId": 5,
197
+                "addedTime": "2019-12-10 21:59:18",
198
+                # etc.
199
+            },
200
+            # etc.
201
+        ]
202
+    }
203
+}
57
 ```
204
 ```
58
 
205
 
59
 
206
 
69
 **Response**
216
 **Response**
70
 
217
 
71
 ```json
218
 ```json
72
-
219
+{
220
+    "status": "success",
221
+    "response": {
222
+        "threads": [
223
+            {
224
+                "forumId": 1,
225
+                "forumName": "Announcements",
226
+                "threadId": 36,
227
+                "threadTitle": "The first hundred gigabytes",
228
+                "postId": 51,
229
+                "lastPostId": 51,
230
+                "locked": false,
231
+                "new": false
232
+            },
233
+            {
234
+                "forumId": 5,
235
+                "forumName": "Bioinformatics",
236
+                "threadId": 27,
237
+                "threadTitle": "Tidy Data: Developing in-house quality standards for original datasets",
238
+                # etc.
239
+            },
240
+            # etc.
241
+        ]
242
+    }
243
+}
73
 ```
244
 ```
74
 
245
 
75
 
246
 
88
 **Response**
259
 **Response**
89
 
260
 
90
 ```json
261
 ```json
91
-
262
+{
263
+    "status": "success",
264
+    "response": {
265
+        "body": "[img]https://i.gr-assets.com/images/S/compressed.photo.goodreads.com/books/1348970636l/12420783.jpg[/img]<br />\r\n<br />\r\nThe human species&#39; enjoyment of food is universal, though different cultures prefer wildly different flavors. Shepherd establishes a new companion field to molecular gastronomy called neurogastronomy. His book explains how the brain constructs and interprets multidimensional flavor profiles as the volatile compounds of food pass through the sense of retronasal smell. The science is accessible and still does justice to the complexity of the olfactory&ndash;neurological interactions described. This book will change the way you eat.<br />\r\n<br />\r\n[url=https://libgen.is/book/index.php?md5=6E9CE452E815418B1F134D5718751000]Library Genesis[/url] / [url=https://www.worldcat.org/title/neurogastronomy-how-the-brain-creates-flavor-and-why-it-matters/oclc/967255519&amp;referer=brief_results]WorldCat[/url]"
266
+    }
267
+}
92
 ```
268
 ```

+ 6
- 6
docs/index.md View File

10
 # Introduction
10
 # Introduction
11
 
11
 
12
 All request URLs are in the form
12
 All request URLs are in the form
13
-ajax.php?action=<action>`.
13
+`ajax.php?action=<action>`.
14
 
14
 
15
 All the JSON returned is in the form
15
 All the JSON returned is in the form
16
 ```json
16
 ```json
17
 {
17
 {
18
-    "status": "success",
19
-    "response": {
20
-	// data
21
-    }
18
+  "status": "success",
19
+  "response": {
20
+    # data
21
+  }
22
 }
22
 }
23
 ```
23
 ```
24
 
24
 
95
 
95
 
96
 ## Better
96
 ## Better
97
 
97
 
98
-Fetch various better.php info.
98
+Fetch better.php (suggested torrent improvements).
99
 
99
 
100
 
100
 
101
 **Request**
101
 **Request**

+ 116
- 10
docs/meta.md View File

6
 ## Index
6
 ## Index
7
 
7
 
8
 Fetch basic site info from the homepage,
8
 Fetch basic site info from the homepage,
9
-e.g., if there's a new announcement.
9
+e.g., your ratio and any unread notices.
10
 
10
 
11
 
11
 
12
 **Request**
12
 **Request**
17
 **Response**
17
 **Response**
18
 
18
 
19
 ```json
19
 ```json
20
-
20
+{
21
+    "status": "success",
22
+    "response": {
23
+        "username": "me",
24
+        "id": 2,
25
+        "authkey": "00000000000000000000000000000000",
26
+        "passkey": "00000000000000000000000000000000",
27
+        "notifications": {
28
+            "messages": 0,
29
+            "notifications": 0,
30
+            "newAnnouncement": false,
31
+            "newBlog": false,
32
+            "newSubscriptions": false
33
+        },
34
+        "userstats": {
35
+            "uploaded": 15918336971,
36
+            "downloaded": 2341094384,
37
+            "ratio": 6.79,
38
+            "requiredratio": 0,
39
+            "class": "Member"
40
+        }
41
+    }
42
+}
21
 ```
43
 ```
22
 
44
 
23
 
45
 
34
 **Response**
56
 **Response**
35
 
57
 
36
 ```json
58
 ```json
37
-
59
+{
60
+    "status": "success",
61
+    "response": {
62
+        "maxUsers": 0,
63
+        "enabledUsers": 82,
64
+        "usersActiveThisDay": 5,
65
+        "usersActiveThisWeek": 10,
66
+        "usersActiveThisMonth": 19,
67
+        "torrentCount": 60,
68
+        "groupCount": 12,
69
+        "artistCount": 151,
70
+        "requestCount": 3,
71
+        "filledRequestCount": 0,
72
+        "seederCount": 225,
73
+        "leecherCount": 0
74
+    }
75
+}
38
 ```
76
 ```
39
 
77
 
40
 
78
 
41
-## Announcements 
79
+## Load average
80
+
81
+Requires moderator permissions to access without error.
42
 
82
 
43
 **Request**
83
 **Request**
44
 
84
 
45
-`ajax.php?action=announcements`
85
+`ajax.php?action=loadavg`
46
 
86
 
47
 
87
 
48
 **Response**
88
 **Response**
49
 
89
 
50
 ```json
90
 ```json
51
-
91
+{
92
+    "status": "success",
93
+    "response": {
94
+        "loadAverage": [
95
+            0.11,
96
+            0.06,
97
+            0.02
98
+        ]
99
+    }
100
+}
52
 ```
101
 ```
53
 
102
 
54
 
103
 
55
-## Load average 
104
+**Error**
105
+
106
+`Invalid authorization key. Go back, refresh, and try again.`
107
+
108
+
109
+## Announcements 
110
+
111
+Fetch the recent news and blogs.
112
+
56
 
113
 
57
 **Request**
114
 **Request**
58
 
115
 
59
-`ajax.php?action=loadavg`
116
+`ajax.php?action=announcements`
60
 
117
 
61
 
118
 
62
 **Response**
119
 **Response**
63
 
120
 
64
 ```json
121
 ```json
65
-
122
+{
123
+    "status": "success",
124
+    "response": {
125
+        "announcements": [
126
+            {
127
+                "newsId": 16,
128
+                "title": "A quick update",
129
+                "bbBody": "BBcode",
130
+                "body": "HTML",
131
+                "newsTime": "2020-11-12 06:43:38"
132
+            },
133
+            {
134
+                "newsId": 14,
135
+                "title": "Summer solstice sitewide freeleech",
136
+                # etc.
137
+            },
138
+            # etc.
139
+        ],
140
+        "blogPosts": [
141
+            {
142
+                "blogId": 3,
143
+                "author": "ohm",
144
+                "title": "The first hundred gigabytes",
145
+                "bbBody": "BBcode",
146
+                "body": "HTML",
147
+                "blogTime": "2020-11-16 16:28:20",
148
+                "threadId": 36
149
+            },
150
+            {
151
+                "blogId": 2,
152
+                "author": "ohm",
153
+                "title": "New category organization and the rationale",
154
+                # etc.
155
+            },
156
+            # etc.
157
+        ]
158
+    }
159
+}
66
 ```
160
 ```
67
 
161
 
68
 
162
 
82
 **Response**
176
 **Response**
83
 
177
 
84
 ```json
178
 ```json
85
-
179
+{
180
+    "status": "success",
181
+    "response": {
182
+        "title": "User Classes",
183
+        "bbBody": "BBcode",
184
+        "body": "HTML",
185
+        "aliases": "userclasses",
186
+        "authorID": 1,
187
+        "authorName": "ohm",
188
+        "date": "2020-11-13 18:46:06",
189
+        "revision": 10
190
+    }
191
+}
86
 ```
192
 ```

+ 93
- 2
docs/requests.md View File

17
 **Response**
17
 **Response**
18
 
18
 
19
 ```json
19
 ```json
20
-
20
+{
21
+    "status": "success",
22
+    "response": {
23
+        "requestId": 2,
24
+        "requestorId": 2,
25
+        "requestorName": "me",
26
+        "isBookmarked": false,
27
+        "requestTax": 0.1,
28
+        "timeAdded": "2020-04-23 02:02:37",
29
+        "canEdit": true,
30
+        "canVote": true,
31
+        "minimumVote": 20971520,
32
+        "voteCount": 1,
33
+        "lastVote": "2020-11-15 06:51:56",
34
+        "topContributors": [
35
+            {
36
+                "userId": 2,
37
+                "userName": "me",
38
+                "bounty": 15461882266
39
+            }
40
+        ],
41
+        "totalBounty": 15461882266,
42
+        "categoryId": 10,
43
+        "categoryName": "Models",
44
+        "title": "Markov State Model Database of Protein Folding Datasets",
45
+        "year": 0,
46
+        "image": "",
47
+        "bbDescription": "BBcode",
48
+        "description": "HTML",
49
+        "artists": [
50
+            {
51
+                "id": 88,
52
+                "name": "Thomas Lane"
53
+            }
54
+        ],
55
+        "isFilled": false,
56
+        "fillerId": 0,
57
+        "fillerName": "",
58
+        "torrentId": 0,
59
+        "timeFilled": "",
60
+        "tags": [
61
+            "coding",
62
+            "proteomics",
63
+            "biochemistry",
64
+            "data.science",
65
+            "gene.expression"
66
+        ],
67
+        "comments": [],
68
+        "commentPage": 1,
69
+        "commentPages": 0
70
+    }
71
+}
21
 ```
72
 ```
22
 
73
 
23
 
74
 
46
 **Response**
97
 **Response**
47
 
98
 
48
 ```json
99
 ```json
49
-
100
+{
101
+    "status": "success",
102
+    "response": {
103
+        "currentPage": 1,
104
+        "pages": 1,
105
+        "results": [
106
+            {
107
+                "requestId": 3,
108
+                "requestorId": 2,
109
+                "requestorName": "me",
110
+                "timeAdded": "2020-11-15 06:49:10",
111
+                "lastVote": "2020-11-15 06:49:27",
112
+                "voteCount": 1,
113
+                "bounty": 7825312768,
114
+                "categoryId": 8,
115
+                "categoryName": "Images",
116
+                "authors": [
117
+                    {
118
+                        "id": 148,
119
+                        "name": "Oliver Batchelor"
120
+                    }
121
+                ],
122
+                "title": "trees.tar.gz",
123
+                "year": 0,
124
+                "picture": "",
125
+                "description": "BBcode",
126
+                "isFilled": false,
127
+                "fillerId": 0,
128
+                "fillerName": "",
129
+                "torrentId": 0,
130
+                "timeFilled": ""
131
+            },
132
+            {
133
+                "requestId": 2,
134
+                "requestorId": 2,
135
+                # etc.
136
+            },
137
+            # etc.
138
+        ]
139
+    }
140
+}
50
 ```
141
 ```

+ 304
- 9
docs/torrents.md View File

17
 **Response**
17
 **Response**
18
 
18
 
19
 ```json
19
 ```json
20
-
20
+{
21
+    "status": "success",
22
+    "response": {
23
+        "group": {
24
+            "description": "HTML",
25
+            "picture": "https://i.imgur.com/sF40cxi.png",
26
+            "id": 1,
27
+            "name": "Alcohol dehydrogenase ADH1",
28
+            "organism": "Saccharomyces cerevisiae",
29
+            "strain": "S288C",
30
+            "authors": [
31
+                {
32
+                    "id": 2,
33
+                    "name": "David Schild"
34
+                },
35
+                {
36
+                    "id": 1,
37
+                    "name": "Robert K. Mortimer"
38
+                }
39
+            ],
40
+            "year": 1985,
41
+            "accession": "YOL086C",
42
+            "categoryId": 1,
43
+            "categoryName": "Sequences",
44
+            "time": "2019-12-10 01:48:07",
45
+            "isBookmarked": false,
46
+            "tags": [
47
+                "coding",
48
+                "fungi",
49
+                "one.shot",
50
+                "organic.chemistry",
51
+                "protocol.available"
52
+            ]
53
+        },
54
+        "torrent": {
55
+            "id": 1,
56
+            "infoHash": "6A5413B9A0C5EF5B68BED6ABBB8112CBE3870647",
57
+            "platform": "Sanger",
58
+            "format": "FASTA",
59
+            "license": "Public Domain",
60
+            "scope": "Contig",
61
+            "annotated": false,
62
+            "archive": "None",
63
+            "fileCount": 4,
64
+            "size": 5754,
65
+            "seeders": 5,
66
+            "leechers": 0,
67
+            "snatched": 3,
68
+            "freeTorrent": false,
69
+            "reported": false,
70
+            "time": "2019-12-10 01:48:08",
71
+            "description": "HTML",
72
+            "fileList": "S288C_YOL086C_ADH1_coding.fsa{{{1095}}}|||S288C_YOL086C_ADH1_flanking.fsa{{{3157}}}|||S288C_YOL086C_ADH1_genomic.fsa{{{1117}}}|||S288C_YOL086C_ADH1_protein.fsa{{{385}}}",
73
+            "filePath": "ADH1 - YOL086C",
74
+            "userId": 0,
75
+            "username": "Anonymous"
76
+        }
77
+    }
78
+}
21
 ```
79
 ```
22
 
80
 
23
 
81
 
35
 **Response**
93
 **Response**
36
 
94
 
37
 ```json
95
 ```json
38
-
96
+{
97
+    "status": "success",
98
+    "response": {
99
+        "group": {
100
+            "description": "HTML",
101
+            "picture": "https://i.imgur.com/SVFU8bC.jpg",
102
+            "id": 37,
103
+            "name": "RSNA Pneumonia Detection Challenge",
104
+            "organism": "",
105
+            "strain": "",
106
+            "authors": [
107
+                {
108
+                    "id": 93,
109
+                    "name": "Radiological Society of North America"
110
+                }
111
+            ],
112
+            "year": 2020,
113
+            "accession": "",
114
+            "categoryId": 8,
115
+            "categoryName": "Images",
116
+            "time": "2020-04-23 05:48:14",
117
+            "isBookmarked": true,
118
+            "tags": [
119
+                "data.science",
120
+                "epidemiology",
121
+                "grayscale",
122
+                "humans",
123
+                "machine.learning",
124
+                "nurse.practitioner",
125
+                "public.health"
126
+            ]
127
+        },
128
+        "torrents": [
129
+            {
130
+                "id": 46,
131
+                "infoHash": "76E026CAA529CED7ECEE99A74E2C060DDEC01F22",
132
+                "platform": "X-Rays",
133
+                "format": "DICOM",
134
+                "license": "Unspecified",
135
+                "scope": "Whole Genome",
136
+                "annotated": true,
137
+                "archive": "ZIP",
138
+                "fileCount": 4,
139
+                "size": 3934053123,
140
+                "seeders": 4,
141
+                "leechers": 0,
142
+                "snatched": 3,
143
+                "freeTorrent": false,
144
+                "reported": false,
145
+                "time": "2020-04-23 05:44:51",
146
+                "description": "Mirror of http://academictorrents.com/details/a0d80e1bb03ef8357d71e058ef9471b4468cd18e",
147
+                "fileList": "stage_2_detailed_class_info.csv{{{1647396}}}|||stage_2_test_images.dcm.zip{{{395756780}}}|||stage_2_train_images.dcm.zip{{{3535158913}}}|||stage_2_train_labels.csv{{{1490034}}}",
148
+                "filePath": "RSNA Pneumonia Detection Challenge - DICOM",
149
+                "userId": 0,
150
+                "username": "Anonymous"
151
+            },
152
+            {
153
+                "id": 47,
154
+                "infoHash": "EFAB8510ED24FC5953AD00993FB62FDDE0013D1D",
155
+                # etc.
156
+            },
157
+            # etc.
158
+        ]
159
+    }
160
+}
39
 ```
161
 ```
40
 
162
 
41
 
163
 
42
 ## Browse (search)
164
 ## Browse (search)
43
 
165
 
44
 Note that BioTorrents.de still uses Oppaitime metadata under the hood.
166
 Note that BioTorrents.de still uses Oppaitime metadata under the hood.
167
+These docs are adapted from What.CD, an older and different distribution.
45
 The advanced search options are certain to change in the future.
168
 The advanced search options are certain to change in the future.
46
 
169
 
47
 
170
 
59
 **Response**
182
 **Response**
60
 
183
 
61
 ```json
184
 ```json
62
-
185
+{
186
+    "status": "success",
187
+    "response": {
188
+        "currentPage": 1,
189
+        "pages": 1,
190
+        "results": [
191
+            {
192
+                "groupId": 57,
193
+                "groupName": "Massachusetts 1:5,000 Color Ortho Imagery",
194
+                "author": "Production Sanborn LLC",
195
+                "picture": "",
196
+                "tags": [
197
+                    "data.science",
198
+                    "one.shot",
199
+                    "true.color",
200
+                    "massachusetts",
201
+                    "geography"
202
+                ],
203
+                "bookmarked": true,
204
+                "groupYear": 2005,
205
+                "groupTime": 1605710633,
206
+                "accession": "",
207
+                "lab": "MassGIS",
208
+                "location": "",
209
+                "maxSize": 24759011328,
210
+                "totalSnatched": 0,
211
+                "totalSeeders": 2,
212
+                "totalLeechers": 0,
213
+                "torrents": [
214
+                    {
215
+                        "torrentId": 67,
216
+                        "authors": [
217
+                            {
218
+                                "id": 152,
219
+                                "name": "Production Sanborn LLC"
220
+                            }
221
+                        ],
222
+                        "platform": "Other",
223
+                        "format": "JPEG 2000",
224
+                        "license": "Unspecified",
225
+                        "scope": "Whole Genome",
226
+                        "annotated": 0,
227
+                        "archive": "ZIP",
228
+                        "fileCount": 1555,
229
+                        "time": "2020-11-18 15:43:53",
230
+                        "size": 24759011328,
231
+                        "snatches": 0,
232
+                        "seeders": 2,
233
+                        "leechers": 0,
234
+                        "isFreeleech": false,
235
+                        "isNeutralLeech": true,
236
+                        "isPersonalFreeleech": false,
237
+                        "canUseToken": false,
238
+                        "hasSnatched": false
239
+                    }
240
+                ]
241
+            },
242
+            {
243
+                "groupId": 52,
244
+                "groupName": "Massachusetts 1:10,000 Coastal Color Orthophoto Images",
245
+                "author": "NOAA Photogrammetry Division, National Geodetic Survey, Massachusetts Coastal Zone Management Office",
246
+                "picture": "",
247
+                # etc.
248
+            },
249
+            # etc.
250
+        ]
251
+    }
252
+}
63
 ```
253
 ```
64
 
254
 
65
 ## Comments 
255
 ## Comments 
66
 
256
 
257
+Fetch comments from torrent pages.
258
+
259
+
67
 **Request**
260
 **Request**
68
 
261
 
69
 `ajax.php?action=tcomments`
262
 `ajax.php?action=tcomments`
74
 **Response**
267
 **Response**
75
 
268
 
76
 ```json
269
 ```json
77
-
270
+{
271
+    "status": "success",
272
+    "response": {
273
+        "page": 1,
274
+        "pages": 1,
275
+        "comments": [
276
+            {
277
+                "postId": 2,
278
+                "addedTime": "2020-01-16 05:31:08",
279
+                "bbBody": "Thanks!",
280
+                "body": "Thanks!",
281
+                "editedUserId": 0,
282
+                "editedTime": "",
283
+                "editedUsername": "",
284
+                "userinfo": {
285
+                    "authorId": 2,
286
+                    "authorName": "me",
287
+                    "artist": false,
288
+                    "donor": false,
289
+                    "warned": false,
290
+                    "avatar": "https://i.imgur.com/OdSSWrw.png",
291
+                    "enabled": true,
292
+                    "userTitle": null
293
+                }
294
+            }
295
+        ]
296
+    }
297
+}
78
 ```
298
 ```
79
 
299
 
80
 
300
 
90
 **Response**
310
 **Response**
91
 
311
 
92
 ```json
312
 ```json
93
-
313
+{
314
+    "status": "success",
315
+    "response": {
316
+        "id": 3,
317
+        "name": "Kratom Genome Project",
318
+        "description": "HTML",
319
+        "creatorID": 2,
320
+        "deleted": false,
321
+        "collageCategoryID": 1,
322
+        "collageCategoryName": "Theme",
323
+        "locked": false,
324
+        "maxGroups": 0,
325
+        "maxGroupsPerUser": 0,
326
+        "hasBookmarked": false,
327
+        "subscriberCount": 0,
328
+        "torrentGroupIDList": [
329
+            7,
330
+            8,
331
+            9,
332
+            10
333
+        ],
334
+        "torrentgroups": [
335
+            {
336
+                "id": 7,
337
+                "name": "Final peer review",
338
+                "year": 2017,
339
+                "categoryId": 11,
340
+                "accession": "",
341
+                "vanityHouse": null,
342
+                "tagList": "plants drug_discovery genomics organic_chemistry one_shot next_gen",
343
+                "picture": "https://i.imgur.com/19Jjdtn.jpg",
344
+                "torrents": [
345
+                    {
346
+                        "torrentid": 7,
347
+                        "platform": "Literature",
348
+                        "fileCount": 6,
349
+                        "size": 488699,
350
+                        "seeders": 5,
351
+                        "leechers": 0,
352
+                        "snatched": 4,
353
+                        "freeTorrent": false,
354
+                        "reported": false,
355
+                        "time": "2019-12-10 04:18:54"
356
+                    }
357
+                ]
358
+            },
359
+            {
360
+                "id": 8,
361
+                "name": "DNA batch 1",
362
+                # etc.
363
+            },
364
+            # etc.
365
+        ]
366
+    }
367
+}
94
 ```
368
 ```
95
 
369
 
96
 
370
 
97
 ## Artist 
371
 ## Artist 
98
 
372
 
99
-Under construction.
100
-Currently not returning torrents.
101
-Please see the below reponse.
373
+Under construction as of 2020-11-24.
374
+Currently not returning the artist's torrent groups.
375
+Please see the below reponse for details.
102
 
376
 
103
 
377
 
104
 **Request**
378
 **Request**
115
 **Response**
389
 **Response**
116
 
390
 
117
 ```json
391
 ```json
118
-
392
+{
393
+    "status": "success",
394
+    "response": {
395
+        "id": 94,
396
+        "name": "Jackie Treehorn",
397
+        "notificationsEnabled": false,
398
+        "hasBookmarked": false,
399
+        "image": "",
400
+        "body": "",
401
+        "vanityHouse": false,
402
+        "tags": [],
403
+        "statistics": {
404
+            "numGroups": 0,
405
+            "numTorrents": 0,
406
+            "numSeeders": 0,
407
+            "numLeechers": 0,
408
+            "numSnatches": 0
409
+        },
410
+        "torrentgroup": [],
411
+        "requests": []
412
+    }
413
+}
119
 ```
414
 ```
120
 
415
 
121
 
416
 

Loading…
Cancel
Save