Meta

Endpoints related to BioTorrents.de itself.

Index

Fetch basic site info from the homepage, e.g., your ratio and any unread notices.

Request

api.php?action=index

Response

{
  "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"
    }
  }
}

Stats

Fetch the homepage sidebar info.

Request

api.php?action=stats

Response

{
  "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
  }
}

Manifest

Fetch an app manifest.

Request

api.php?action=manifest

Response

{
  "status": "success",
  "response": {
    "name": "BioTorrents.de",
    "short_name": "BioTorrents.de",
    "description": "A platform to share biological sequence and medical imaging data",
    "start_url": "index.php",
    "display": "standalone",
    "background_color": "#ffffff",
    "theme_color": "#0288d1",
    "icons": [
      {
        "src": "/static/common/icon.png",
        "sizes": "120x120",
        "type": "image/png"
      }
    ]
  }
}

Load average

Requires moderator permissions to access without error.

Request

api.php?action=loadavg

Response

{
  "status": "success",
  "response": {
    "loadAverage": [0.11, 0.06, 0.02]
  }
}

Error

Invalid authorization key. Go back, refresh, and try again.

Announcements

Fetch the recent news and blogs.

Request

api.php?action=announcements

Response

{
    "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.
        ]
    }
}

Wiki

Either id or name is required.

Request

api.php?action=wiki

&id= — page id to display (required)

&name= — page alias to display

Response

{
  "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
  }
}

Ontology

Fetch a site metadata blueprint.

Request

api.php?action=ontology

Response

{
    "status": "success",
    "response": {
        "SEQ": {
            "ID": 1,
            "Name": "Sequences",
            "Icon": "/static/common/bioicons/sequences.png",
            "Platforms": {
                "0": "Complete Genomics",
                "1": "cPAS-BGI/MGI",
                "2": "Helicos",
                "3": "Illumina HiSeq",
                # etc.
            },
            "Formats": {
                "NucleoSeq": {
                    "BAM": {
                        "0": "bam"
                    },
                    "CRAM": {
                        "0": "cram"
                    },
                    "EMBL": {
                        "0": "embl"
                    },
                    # etc.
                "ProtSeq": {
                    "ABI/Sciex": {
                        "0": "t2d",
                        "1": "wiff"
                    },
                    "APML": {
                        "0": "apml"
                    },
                    # etc.
                },
        # etc.
            },
            "Description": "For data that's ACGT, ACGU, amino acid letters on disk."
        },
        "GRF": {
            "ID": 2,
            "Name": "Graphs",
            "Icon": "/static/common/bioicons/graphs.png",
            # etc.
        },
        # etc.
    }
}