Documentation/docs/index.md

The JSON API provides an easily parseable interface to BioTorrents.de. Please use the navigation menu to find lists of endpoints, their arguments, and example responses.

Introduction

All request URLs are in the form

ajax.php?action=<action>

All the JSON returned is in the form

{
  "status": "success",
  "response": {
    # data
  },
  "info": {
    "source": "BioTorrents.de",
    "version": 1
  }
}

If the request is invalid, or a problem occurs, the status will be failure. In this case the value of response is undefined.

Bearer token auth

First, generate a token in your profile security settings and keep it safe. It’s functionally a password, and like a password, it can’t be recovered later. Then POST an RFC 6750–compliant bearer token along with each GET request:

curl biotorrents.de/ajax.php?action=index \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}"

Cookie auth

Please send a POST request to https://biotorrents.de/login.php with username and password, or acquire a cookie from a browser session using the developer tools. Then store the cookie and use it to access the rest of the API.

Libraries

These are the current public projects listed on the What.CD Gazelle wiki. Questions about the API can be answered in #development on Slack.

Please get it touch if you’d like me to list your project below.

Language	GitHub
C#	frankston/WhatAPI
Go	kdvh/whatapi
JavaScript	deoxxa/whatcd
Java	Gwindow/WhatAPI
PHP	Jleagle/gazelle-api-client
Python	isaaczafuta/whatapi
Ruby	chasemgray/RubyGazelle

Caveats

Abusing or using this API for malicious purposes is a bannable offense and will not be taken lightly.

Rate limit

The API is rate-limited to one request every 6 seconds. This limit doesn’t apply to users in the Donor class. Please consider donating to support this scientific resource’s development.

Under construction

Some endpoints aren’t working correctly right now:

• artist
• preview

Oppaitime Gazelle also contains other undocumented endpoints:

• get_friends
• news_ajax
• send_recommendation

Not implemented

Similar artists

Request

ajax.php?action=similar_artists

&id= — id of artist (required)

&limit= — maximum number of results to return (fewer might be returned)

Response

Better

Fetch better.php (suggested torrent improvements).

Request

ajax.php?action=better

Response

Torrent info

Request

ajax.php?action=torrent_info

Response

Check private

Request

ajax.php?action=checkprivate

Response

Vote favorite

Request

ajax.php?action=votefavorite

Response