api-docs/usage.rst

   1 API Usage
   2 =========
   3
   4
   5 Client Registration
   6 -------------------
   7
   8 Most API endpoints can only be accessed by registered clients using a client
   9 key. Clients can be registered for free at LINK.
  10
  11 TODO: User-Agent?
  12
  13
  14 Allowed Usage
  15 -------------
  16
  17 **Open source clients** can issue an unlimited number of requests to the API.
  18
  19 **Closed source Clients** (this includes free-of-charge closed source clients)
  20 have a quota of requests per day (UTC). The quota depends on the features
  21 they implement (and activate/enable by default).
  22
  23 The following table shows how the client quota is increased by implementing a
  24 certain feature.
  25
  26 +------------------------+---------------+----------------+
  27 | Features               | Open source   | Closed source  |
  28 +========================+===============+================+
  29 | Podcast Search         | unlimited     | unlimited      |
  30 +------------------------+---------------+----------------+
  31 | Podcast Toplist        | unlimited     | +1000          |
  32 +------------------------+---------------+----------------+
  33 | Top Tags               | unlimited     | +1000          |
  34 +------------------------+---------------+----------------+
  35 | Tag-Podcasts           | unlimited     | +1000          |
  36 +------------------------+---------------+----------------+
  37 | Subscriptions Download | unlimited     | +1000          |
  38 +------------------------+---------------+----------------+
  39 | Subscriptions Upload   | unlimited     | +5000          |
  40 +------------------------+---------------+----------------+
  41 | Device List and Config | unlimited     | +1000          |
  42 +------------------------+---------------+----------------+
  43 | Episode Favorites      | unlimited     | +1000          |
  44 +------------------------+---------------+----------------+
  45 | Authentication         | unlimited     | unlimited      |
  46 +------------------------+---------------+----------------+
  47 | Device Sync            | unlimited     | +1000          |
  48 +------------------------+---------------+----------------+
  49 | Events Upload          | unlimited     | +10000         |
  50 +------------------------+---------------+----------------+
  51 | Events Download        | unlimited     | +10000         |
  52 +------------------------+---------------+----------------+
  53 | Podcast Lists          | unlimited     | +1000          |
  54 +------------------------+---------------+----------------+
  55 | Settings               | unlimited     | +1000          |
  56 +------------------------+---------------+----------------+