REST API Documentation

{
  "endpoint": "/torrents",
  "method": "GET",
  "description": "will return the list of all torrents"
}

{
  "endpoint": "/torrents/{infoHash}",
  "method": "GET",
  "description": "will return a single torrent"
}

{
  "endpoint": "/torrents/{infoHash}/stats",
  "method": "GET",
  "description": "will return the torrent stats (speed, bandwidth, etc.)"
}

{
  "endpoint": "/torrents/{infoHash}/files",
  "method": "GET",
  "description": "will return the M3U playlist"
}

{
  "endpoint": " /torrents/{infoHash}/files/{path}",
  "method": "GET",
  "description": " will start streaming the file (honoring the `Range` header)"
}

{
  "endpoint": "/torrents/{infoHash}/pause",
  "method": "POST",
  "description": "will pause/resume the swarm and peer discovery"
}

{
  "endpoint": ["/torrents/{infoHash}/start", "/torrents/{infoHash}/stop"],
  "method": "POST",
  "description": "will start/stop the download by selecting/deselecting all files"
}

{
  "endpoint": [
    "/torrents/{infoHash}/start/{index}",
    "/torrents/{infoHash}/stop/{index}"
  ],
  "method": "POST",
  "description": "will start/stop downloading a particular file (by index)"
}

{
  "endpoint": "/torrents",
  "method": "POST",
  "description": "will add a new torrent (`{"link":"magnet link or URL"`)}"
}

{
  "endpoint": " /upload",
  "method": "POST",
  "description": " will accept a .torrent file as an attachment (`file` field in `multipart/form-data`)"
}

{
  "endpoint": "/torrents/{infoHash}",
  "method": "DELETE",
  "description": "will delete the torrent"
}