Example responses up to Top 10

docs/forums.md

@@ -13,7 +13,55 @@ Endpoints related to the forums.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "categories": [
+            {
+                "categoryID": 5,
+                "categoryName": "Community",
+                "forums": [
+                    {
+                        "forumId": 4,
+                        "forumName": "General",
+                        "forumDescription": "",
+                        "numTopics": 5,
+                        "numPosts": 9,
+                        "lastPostId": 39,
+                        "lastAuthorId": 2,
+                        "lastPostAuthorName": "me",
+                        "lastTopicId": 30,
+                        "lastTime": "2020-05-27 17:53:57",
+                        "specificRules": [],
+                        "lastTopic": "Unplugging: Tune in, turn on, drop out",
+                        "read": false,
+                        "locked": false,
+                        "sticky": false
+                    },
+                    {
+                        "forumId": 13,
+                        "forumName": "Book Club",
+                        # etc.
+                    },
+                    # etc.
+                ]
+            },
+            {
+                "categoryID": 10,
+                "categoryName": "Help",
+                "forums": [
+                    {
+                        "forumId": 9,
+                        "forumName": "BitTorrent",
+                        # etc.
+                    },
+                    # etc.
+                ]
+            },
+            # etc.
+        ]
+    }
+}
 ```
 
 
@@ -31,7 +79,39 @@ Endpoints related to the forums.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "forumName": "Bioinformatics",
+        "specificRules": [],
+        "currentPage": 1,
+        "pages": 1,
+        "threads": [
+            {
+                "topicId": 27,
+                "title": "Tidy Data: Developing in-house quality standards for original datasets",
+                "authorId": 2,
+                "authorName": "me",
+                "locked": false,
+                "sticky": false,
+                "postCount": 1,
+                "lastID": 36,
+                "lastTime": "2020-05-08 17:57:40",
+                "lastAuthorId": 2,
+                "lastAuthorName": "me",
+                "lastReadPage": 1,
+                "lastReadPostId": 36,
+                "read": true
+            },
+            {
+                "topicId": 26,
+                "title": "Microscopy image processing tools",
+                # etc.
+            },
+            # etc.
+        ]
+    }
+}
 ```
 
 
@@ -53,7 +133,74 @@ Endpoints related to the forums.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "forumId": 10,
+        "forumName": "Website",
+        "threadId": 2,
+        "threadTitle": "Report broken site features",
+        "subscribed": false,
+        "locked": false,
+        "sticky": false,
+        "currentPage": 1,
+        "pages": 1,
+        "poll": null,
+        "posts": [
+            {
+                "postId": 2,
+                "addedTime": "2019-12-10 06:47:19",
+                "bbBody": "BBcode",
+                "body": "HTML",
+                "editedUserId": 1,
+                "editedTime": "2020-01-18 05:24:59",
+                "editedUsername": "ohm",
+                "author": {
+                    "authorId": 1,
+                    "authorName": "ohm",
+                    "paranoia": [
+                        "downloaded",
+                        "uploaded",
+                        "ratio",
+                        "lastseen",
+                        "requiredratio",
+                        "invitedcount",
+                        "artistsadded",
+                        "notifications",
+                        "torrentcomments+",
+                        "collages+",
+                        "collagecontribs+",
+                        "uploads+",
+                        "uniquegroups+",
+                        "perfectflacs+",
+                        "seeding+",
+                        "leeching+",
+                        "snatched+",
+                        "requestsfilled_list",
+                        "requestsfilled_count",
+                        "requestsfilled_bounty",
+                        "requestsvoted_list",
+                        "requestsvoted_count",
+                        "requestsvoted_bounty",
+                        "hide_donor_heart"
+                    ],
+                    "artist": false,
+                    "donor": true,
+                    "warned": false,
+                    "avatar": "",
+                    "enabled": true,
+                    "userTitle": null
+                }
+            },
+            {
+                "postId": 5,
+                "addedTime": "2019-12-10 21:59:18",
+                # etc.
+            },
+            # etc.
+        ]
+    }
+}
 ```
 
 
@@ -69,7 +216,31 @@ Endpoints related to the forums.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "threads": [
+            {
+                "forumId": 1,
+                "forumName": "Announcements",
+                "threadId": 36,
+                "threadTitle": "The first hundred gigabytes",
+                "postId": 51,
+                "lastPostId": 51,
+                "locked": false,
+                "new": false
+            },
+            {
+                "forumId": 5,
+                "forumName": "Bioinformatics",
+                "threadId": 27,
+                "threadTitle": "Tidy Data: Developing in-house quality standards for original datasets",
+                # etc.
+            },
+            # etc.
+        ]
+    }
+}
 ```
 
 
@@ -88,5 +259,10 @@ Fetch a post's unrendered content.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "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]"
+    }
+}
 ```

docs/index.md

@@ -10,15 +10,15 @@ and storing a cookie to be used to access the rest of the API.
 # Introduction
 
 All request URLs are in the form
-ajax.php?action=<action>`.
+`ajax.php?action=<action>`.
 
 All the JSON returned is in the form
 ```json
 {
-    "status": "success",
-    "response": {
-	// data
-    }
+  "status": "success",
+  "response": {
+    # data
+  }
 }
 ```
 
@@ -95,7 +95,7 @@ also contains other undocumented endpoints:
 
 ## Better
 
-Fetch various better.php info.
+Fetch better.php (suggested torrent improvements).
 
 
 **Request**

docs/meta.md

@@ -6,7 +6,7 @@ Endpoints related to BioTorrents.de itself.
 ## Index
 
 Fetch basic site info from the homepage,
-e.g., if there's a new announcement.
+e.g., your ratio and any unread notices.
 
 
 **Request**
@@ -17,7 +17,29 @@ e.g., if there's a new announcement.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "username": "me",
+        "id": 2,
+        "authkey": "00000000000000000000000000000000",
+        "passkey": "00000000000000000000000000000000",
+        "notifications": {
+            "messages": 0,
+            "notifications": 0,
+            "newAnnouncement": false,
+            "newBlog": false,
+            "newSubscriptions": false
+        },
+        "userstats": {
+            "uploaded": 15918336971,
+            "downloaded": 2341094384,
+            "ratio": 6.79,
+            "requiredratio": 0,
+            "class": "Member"
+        }
+    }
+}
 ```
 
 
@@ -34,35 +56,107 @@ Fetch the homepage sidebar info.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "maxUsers": 0,
+        "enabledUsers": 82,
+        "usersActiveThisDay": 5,
+        "usersActiveThisWeek": 10,
+        "usersActiveThisMonth": 19,
+        "torrentCount": 60,
+        "groupCount": 12,
+        "artistCount": 151,
+        "requestCount": 3,
+        "filledRequestCount": 0,
+        "seederCount": 225,
+        "leecherCount": 0
+    }
+}
 ```
 
 
-## Announcements 
+## Load average
+
+Requires moderator permissions to access without error.
 
 **Request**
 
-`ajax.php?action=announcements`
+`ajax.php?action=loadavg`
 
 
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "loadAverage": [
+            0.11,
+            0.06,
+            0.02
+        ]
+    }
+}
 ```
 
 
-## Load average 
+**Error**
+
+`Invalid authorization key. Go back, refresh, and try again.`
+
+
+## Announcements 
+
+Fetch the recent news and blogs.
+
 
 **Request**
 
-`ajax.php?action=loadavg`
+`ajax.php?action=announcements`
 
 
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "announcements": [
+            {
+                "newsId": 16,
+                "title": "A quick update",
+                "bbBody": "BBcode",
+                "body": "HTML",
+                "newsTime": "2020-11-12 06:43:38"
+            },
+            {
+                "newsId": 14,
+                "title": "Summer solstice sitewide freeleech",
+                # etc.
+            },
+            # etc.
+        ],
+        "blogPosts": [
+            {
+                "blogId": 3,
+                "author": "ohm",
+                "title": "The first hundred gigabytes",
+                "bbBody": "BBcode",
+                "body": "HTML",
+                "blogTime": "2020-11-16 16:28:20",
+                "threadId": 36
+            },
+            {
+                "blogId": 2,
+                "author": "ohm",
+                "title": "New category organization and the rationale",
+                # etc.
+            },
+            # etc.
+        ]
+    }
+}
 ```
 
 
@@ -82,5 +176,17 @@ Note that either `id` or `name` is required.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "title": "User Classes",
+        "bbBody": "BBcode",
+        "body": "HTML",
+        "aliases": "userclasses",
+        "authorID": 1,
+        "authorName": "ohm",
+        "date": "2020-11-13 18:46:06",
+        "revision": 10
+    }
+}
 ```

docs/requests.md

@@ -17,7 +17,58 @@ Endpoints related to torrent requests.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "requestId": 2,
+        "requestorId": 2,
+        "requestorName": "me",
+        "isBookmarked": false,
+        "requestTax": 0.1,
+        "timeAdded": "2020-04-23 02:02:37",
+        "canEdit": true,
+        "canVote": true,
+        "minimumVote": 20971520,
+        "voteCount": 1,
+        "lastVote": "2020-11-15 06:51:56",
+        "topContributors": [
+            {
+                "userId": 2,
+                "userName": "me",
+                "bounty": 15461882266
+            }
+        ],
+        "totalBounty": 15461882266,
+        "categoryId": 10,
+        "categoryName": "Models",
+        "title": "Markov State Model Database of Protein Folding Datasets",
+        "year": 0,
+        "image": "",
+        "bbDescription": "BBcode",
+        "description": "HTML",
+        "artists": [
+            {
+                "id": 88,
+                "name": "Thomas Lane"
+            }
+        ],
+        "isFilled": false,
+        "fillerId": 0,
+        "fillerName": "",
+        "torrentId": 0,
+        "timeFilled": "",
+        "tags": [
+            "coding",
+            "proteomics",
+            "biochemistry",
+            "data.science",
+            "gene.expression"
+        ],
+        "comments": [],
+        "commentPage": 1,
+        "commentPages": 0
+    }
+}
 ```
 
 
@@ -46,5 +97,45 @@ If no arguments are specified then the most recent requests are shown.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "currentPage": 1,
+        "pages": 1,
+        "results": [
+            {
+                "requestId": 3,
+                "requestorId": 2,
+                "requestorName": "me",
+                "timeAdded": "2020-11-15 06:49:10",
+                "lastVote": "2020-11-15 06:49:27",
+                "voteCount": 1,
+                "bounty": 7825312768,
+                "categoryId": 8,
+                "categoryName": "Images",
+                "authors": [
+                    {
+                        "id": 148,
+                        "name": "Oliver Batchelor"
+                    }
+                ],
+                "title": "trees.tar.gz",
+                "year": 0,
+                "picture": "",
+                "description": "BBcode",
+                "isFilled": false,
+                "fillerId": 0,
+                "fillerName": "",
+                "torrentId": 0,
+                "timeFilled": ""
+            },
+            {
+                "requestId": 2,
+                "requestorId": 2,
+                # etc.
+            },
+            # etc.
+        ]
+    }
+}
 ```

docs/torrents.md

@@ -17,7 +17,65 @@ Endpoints related to torrents.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "group": {
+            "description": "HTML",
+            "picture": "https://i.imgur.com/sF40cxi.png",
+            "id": 1,
+            "name": "Alcohol dehydrogenase ADH1",
+            "organism": "Saccharomyces cerevisiae",
+            "strain": "S288C",
+            "authors": [
+                {
+                    "id": 2,
+                    "name": "David Schild"
+                },
+                {
+                    "id": 1,
+                    "name": "Robert K. Mortimer"
+                }
+            ],
+            "year": 1985,
+            "accession": "YOL086C",
+            "categoryId": 1,
+            "categoryName": "Sequences",
+            "time": "2019-12-10 01:48:07",
+            "isBookmarked": false,
+            "tags": [
+                "coding",
+                "fungi",
+                "one.shot",
+                "organic.chemistry",
+                "protocol.available"
+            ]
+        },
+        "torrent": {
+            "id": 1,
+            "infoHash": "6A5413B9A0C5EF5B68BED6ABBB8112CBE3870647",
+            "platform": "Sanger",
+            "format": "FASTA",
+            "license": "Public Domain",
+            "scope": "Contig",
+            "annotated": false,
+            "archive": "None",
+            "fileCount": 4,
+            "size": 5754,
+            "seeders": 5,
+            "leechers": 0,
+            "snatched": 3,
+            "freeTorrent": false,
+            "reported": false,
+            "time": "2019-12-10 01:48:08",
+            "description": "HTML",
+            "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}}}",
+            "filePath": "ADH1 - YOL086C",
+            "userId": 0,
+            "username": "Anonymous"
+        }
+    }
+}
 ```
 
 
@@ -35,13 +93,78 @@ Endpoints related to torrents.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "group": {
+            "description": "HTML",
+            "picture": "https://i.imgur.com/SVFU8bC.jpg",
+            "id": 37,
+            "name": "RSNA Pneumonia Detection Challenge",
+            "organism": "",
+            "strain": "",
+            "authors": [
+                {
+                    "id": 93,
+                    "name": "Radiological Society of North America"
+                }
+            ],
+            "year": 2020,
+            "accession": "",
+            "categoryId": 8,
+            "categoryName": "Images",
+            "time": "2020-04-23 05:48:14",
+            "isBookmarked": true,
+            "tags": [
+                "data.science",
+                "epidemiology",
+                "grayscale",
+                "humans",
+                "machine.learning",
+                "nurse.practitioner",
+                "public.health"
+            ]
+        },
+        "torrents": [
+            {
+                "id": 46,
+                "infoHash": "76E026CAA529CED7ECEE99A74E2C060DDEC01F22",
+                "platform": "X-Rays",
+                "format": "DICOM",
+                "license": "Unspecified",
+                "scope": "Whole Genome",
+                "annotated": true,
+                "archive": "ZIP",
+                "fileCount": 4,
+                "size": 3934053123,
+                "seeders": 4,
+                "leechers": 0,
+                "snatched": 3,
+                "freeTorrent": false,
+                "reported": false,
+                "time": "2020-04-23 05:44:51",
+                "description": "Mirror of http://academictorrents.com/details/a0d80e1bb03ef8357d71e058ef9471b4468cd18e",
+                "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}}}",
+                "filePath": "RSNA Pneumonia Detection Challenge - DICOM",
+                "userId": 0,
+                "username": "Anonymous"
+            },
+            {
+                "id": 47,
+                "infoHash": "EFAB8510ED24FC5953AD00993FB62FDDE0013D1D",
+                # etc.
+            },
+            # etc.
+        ]
+    }
+}
 ```
 
 
 ## Browse (search)
 
 Note that BioTorrents.de still uses Oppaitime metadata under the hood.
+These docs are adapted from What.CD, an older and different distribution.
 The advanced search options are certain to change in the future.
 
 
@@ -59,11 +182,81 @@ The advanced search options are certain to change in the future.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "currentPage": 1,
+        "pages": 1,
+        "results": [
+            {
+                "groupId": 57,
+                "groupName": "Massachusetts 1:5,000 Color Ortho Imagery",
+                "author": "Production Sanborn LLC",
+                "picture": "",
+                "tags": [
+                    "data.science",
+                    "one.shot",
+                    "true.color",
+                    "massachusetts",
+                    "geography"
+                ],
+                "bookmarked": true,
+                "groupYear": 2005,
+                "groupTime": 1605710633,
+                "accession": "",
+                "lab": "MassGIS",
+                "location": "",
+                "maxSize": 24759011328,
+                "totalSnatched": 0,
+                "totalSeeders": 2,
+                "totalLeechers": 0,
+                "torrents": [
+                    {
+                        "torrentId": 67,
+                        "authors": [
+                            {
+                                "id": 152,
+                                "name": "Production Sanborn LLC"
+                            }
+                        ],
+                        "platform": "Other",
+                        "format": "JPEG 2000",
+                        "license": "Unspecified",
+                        "scope": "Whole Genome",
+                        "annotated": 0,
+                        "archive": "ZIP",
+                        "fileCount": 1555,
+                        "time": "2020-11-18 15:43:53",
+                        "size": 24759011328,
+                        "snatches": 0,
+                        "seeders": 2,
+                        "leechers": 0,
+                        "isFreeleech": false,
+                        "isNeutralLeech": true,
+                        "isPersonalFreeleech": false,
+                        "canUseToken": false,
+                        "hasSnatched": false
+                    }
+                ]
+            },
+            {
+                "groupId": 52,
+                "groupName": "Massachusetts 1:10,000 Coastal Color Orthophoto Images",
+                "author": "NOAA Photogrammetry Division, National Geodetic Survey, Massachusetts Coastal Zone Management Office",
+                "picture": "",
+                # etc.
+            },
+            # etc.
+        ]
+    }
+}
 ```
 
 ## Comments 
 
+Fetch comments from torrent pages.
+
+
 **Request**
 
 `ajax.php?action=tcomments`
@@ -74,7 +267,34 @@ The advanced search options are certain to change in the future.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "page": 1,
+        "pages": 1,
+        "comments": [
+            {
+                "postId": 2,
+                "addedTime": "2020-01-16 05:31:08",
+                "bbBody": "Thanks!",
+                "body": "Thanks!",
+                "editedUserId": 0,
+                "editedTime": "",
+                "editedUsername": "",
+                "userinfo": {
+                    "authorId": 2,
+                    "authorName": "me",
+                    "artist": false,
+                    "donor": false,
+                    "warned": false,
+                    "avatar": "https://i.imgur.com/OdSSWrw.png",
+                    "enabled": true,
+                    "userTitle": null
+                }
+            }
+        ]
+    }
+}
 ```
 
 
@@ -90,15 +310,69 @@ The advanced search options are certain to change in the future.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "id": 3,
+        "name": "Kratom Genome Project",
+        "description": "HTML",
+        "creatorID": 2,
+        "deleted": false,
+        "collageCategoryID": 1,
+        "collageCategoryName": "Theme",
+        "locked": false,
+        "maxGroups": 0,
+        "maxGroupsPerUser": 0,
+        "hasBookmarked": false,
+        "subscriberCount": 0,
+        "torrentGroupIDList": [
+            7,
+            8,
+            9,
+            10
+        ],
+        "torrentgroups": [
+            {
+                "id": 7,
+                "name": "Final peer review",
+                "year": 2017,
+                "categoryId": 11,
+                "accession": "",
+                "vanityHouse": null,
+                "tagList": "plants drug_discovery genomics organic_chemistry one_shot next_gen",
+                "picture": "https://i.imgur.com/19Jjdtn.jpg",
+                "torrents": [
+                    {
+                        "torrentid": 7,
+                        "platform": "Literature",
+                        "fileCount": 6,
+                        "size": 488699,
+                        "seeders": 5,
+                        "leechers": 0,
+                        "snatched": 4,
+                        "freeTorrent": false,
+                        "reported": false,
+                        "time": "2019-12-10 04:18:54"
+                    }
+                ]
+            },
+            {
+                "id": 8,
+                "name": "DNA batch 1",
+                # etc.
+            },
+            # etc.
+        ]
+    }
+}
 ```
 
 
 ## Artist 
 
-Under construction.
-Currently not returning torrents.
-Please see the below reponse.
+Under construction as of 2020-11-24.
+Currently not returning the artist's torrent groups.
+Please see the below reponse for details.
 
 
 **Request**
@@ -115,7 +389,28 @@ Please see the below reponse.
 **Response**
 
 ```json
-
+{
+    "status": "success",
+    "response": {
+        "id": 94,
+        "name": "Jackie Treehorn",
+        "notificationsEnabled": false,
+        "hasBookmarked": false,
+        "image": "",
+        "body": "",
+        "vanityHouse": false,
+        "tags": [],
+        "statistics": {
+            "numGroups": 0,
+            "numTorrents": 0,
+            "numSeeders": 0,
+            "numLeechers": 0,
+            "numSnatches": 0
+        },
+        "torrentgroup": [],
+        "requests": []
+    }
+}
 ```