Skip to content

Latest commit

 

History

History
451 lines (309 loc) · 28.4 KB

torrents_service.md

File metadata and controls

451 lines (309 loc) · 28.4 KB
Raw

TorrentsService

A list of all methods in the TorrentsService service. Click on the method name to view detailed information about that method.

Methods Description
CreateTorrent ### Overview Creates a torrent under your account. Simply send either a magnet link, or a torrent file. Once they have been checked, they will begin downloading assuming your account has available active download slots, and they aren't too large. ### Authorization Requires an API key using the Authorization Bearer Header.
ControlTorrent ### Overview Controls a torrent. By sending the torrent's ID and the type of operation you want to perform, it will send that request to the torrent client. Operations are either: - Reannounce reannounces the torrent to get new peers - Delete deletes the torrent from the client and your account permanently - Resume resumes a paused torrent ### Authorization Requires an API key using the Authorization Bearer Header.
ControlQueuedTorrent ### Overview Controls a queued torrent. By sending the queued torrent's ID and the type of operation you want to perform, it will perform that action on the queued torrent. Operations are either: - Delete deletes the queued torrent from your account ### Authorization Requires an API key using the Authorization Bearer Header.
RequestDownloadLink ### Overview Requests the download link from the server. Because downloads are metered, TorBox cannot afford to allow free access to the links directly. This endpoint opens the link for 1 hour for downloads. Once a download is started, the user has nearly unlilimited time to download the file. The 1 hour time limit is simply for starting downloads. This prevents long term link sharing. ### Authorization Requires an API key as a parameter for the token parameter.
GetTorrentList ### Overview Gets the user's torrent list. This gives you the needed information to perform other torrent actions. This information only gets updated every 600 seconds, or when the Request Update On Torrent request is sent to the relay API. #### Download States: - "downloading" -> The torrent is currently downloading. - "uploading" -> The torrent is currently seeding. - "stalled (no seeds)" -> The torrent is trying to download, but there are no seeds connected to download from. - "paused" -> The torrent is paused. - "completed" -> The torrent is completely downloaded. Do not use this for download completion status. - "cached" -> The torrent is cached from the server. - "metaDL" -> The torrent is downloading metadata from the hoard. - "checkingResumeData" -> The torrent is checking resumable data. All other statuses are basic qBittorrent states. Check out here for the full list. ### Authorization Requires an API key using the Authorization Bearer Header.
GetTorrentCachedAvailability ### Overview Takes in a list of comma separated torrent hashes and checks if the torrent is cached. This endpoint only gets a max of around 100 at a time, due to http limits in queries. If you want to do more, you can simply do more hash queries. Such as: ?hash=XXXX&hash=XXXX&hash=XXXX or ?hash=XXXX,XXXX&hash=XXXX&hash=XXXX,XXXX and this will work too. Performance is very fast. Less than 1 second per 100. Time is approximately O(log n) time for those interested in taking it to its max. That is without caching as well. This endpoint stores a cache for an hour. You may also pass a format parameter with the format you want the data in. Options are either object or list. You can view examples of both below. ### Authorization Requires an API key using the Authorization Bearer Header.
SearchAllTorrentsFromScraper ### Overview Uses Meilisearch to search for scraped torrents. This is a basic torrent aggregator system and has no real relation to TorBox. It is simply a tool you can use. It does not have cache information, or anything special like that, and will not have any of that information. This is simply a torrent search, nothing more. You may use this for anything. TorBox uses it in the website to make it easy for users to find torrents without having to go and find them on sketchy websites. ### Authorization None required.
ExportTorrentData ### Overview Exports the magnet or torrent file. Requires a type to be passed. If type is magnet, it will return a JSON response with the magnet as a string in the data key. If type is file, it will return a bittorrent file as a download. Not compatible with cached downloads. ### Authorization Requires an API key using the Authorization Bearer Header.
GetTorrentInfo ### Overview A general route that allows you to give a hash, and TorBox will return data about the torrent. This data is retrieved from the Bittorrent network, so expect it to take some time. If the request goes longer than 10 seconds, TorBox will cancel it. You can adjust this if you like, but the default is 10 seconds. This route is cached as well, so subsequent requests will be instant. ### Authorization None required.
GetQueuedTorrents ### Overview Retrieves all of a user's queued torrents. ### Authorization Requires an API key using the Authorization Bearer Header.

CreateTorrent

Overview Creates a torrent under your account. Simply send either a magnet link, or a torrent file. Once they have been checked, they will begin downloading assuming your account has available active download slots, and they aren't too large. ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: POST
  • Endpoint: /{api_version}/api/torrents/createtorrent

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
createTorrentRequest CreateTorrentRequest ✅

Return Type

CreateTorrentOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
  "torbox-sdk-go/pkg/torrents"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)


request := torrents.CreateTorrentRequest{}
request.SetFile("")
request.SetMagnet("Magnet")

response, err := client.Torrents.CreateTorrent(context.Background(), "apiVersion", request)
if err != nil {
  panic(err)
}

fmt.Print(response)

ControlTorrent

Overview Controls a torrent. By sending the torrent's ID and the type of operation you want to perform, it will send that request to the torrent client. Operations are either: - Reannounce reannounces the torrent to get new peers - Delete deletes the torrent from the client and your account permanently - Resume resumes a paused torrent ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: POST
  • Endpoint: /{api_version}/api/torrents/controltorrent

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
body []byte ✅

Return Type

ControlTorrentOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)

response, err := client.Torrents.ControlTorrent(context.Background(), "apiVersion", request)
if err != nil {
  panic(err)
}

fmt.Print(response)

ControlQueuedTorrent

Overview Controls a queued torrent. By sending the queued torrent's ID and the type of operation you want to perform, it will perform that action on the queued torrent. Operations are either: - Delete deletes the queued torrent from your account ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: POST
  • Endpoint: /{api_version}/api/torrents/controlqueued

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
body []byte ✅

Return Type

ControlQueuedTorrentOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)

response, err := client.Torrents.ControlQueuedTorrent(context.Background(), "apiVersion", request)
if err != nil {
  panic(err)
}

fmt.Print(response)

RequestDownloadLink

Overview Requests the download link from the server. Because downloads are metered, TorBox cannot afford to allow free access to the links directly. This endpoint opens the link for 1 hour for downloads. Once a download is started, the user has nearly unlilimited time to download the file. The 1 hour time limit is simply for starting downloads. This prevents long term link sharing. ### Authorization Requires an API key as a parameter for the token parameter.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/torrents/requestdl

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
params RequestDownloadLinkRequestParams ✅ Additional request parameters

Return Type

RequestDownloadLinkOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
  "torbox-sdk-go/pkg/torrents"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)


params := torrents.RequestDownloadLinkRequestParams{}


response, err := client.Torrents.RequestDownloadLink(context.Background(), "apiVersion", params)
if err != nil {
  panic(err)
}

fmt.Print(response)

GetTorrentList

Overview Gets the user's torrent list. This gives you the needed information to perform other torrent actions. This information only gets updated every 600 seconds, or when the Request Update On Torrent request is sent to the relay API. #### Download States: - "downloading" -> The torrent is currently downloading. - "uploading" -> The torrent is currently seeding. - "stalled (no seeds)" -> The torrent is trying to download, but there are no seeds connected to download from. - "paused" -> The torrent is paused. - "completed" -> The torrent is completely downloaded. Do not use this for download completion status. - "cached" -> The torrent is cached from the server. - "metaDL" -> The torrent is downloading metadata from the hoard. - "checkingResumeData" -> The torrent is checking resumable data. All other statuses are basic qBittorrent states. Check out here for the full list. ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/torrents/mylist

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
params GetTorrentListRequestParams ✅ Additional request parameters

Return Type

GetTorrentListOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
  "torbox-sdk-go/pkg/torrents"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)


params := torrents.GetTorrentListRequestParams{}


response, err := client.Torrents.GetTorrentList(context.Background(), "apiVersion", params)
if err != nil {
  panic(err)
}

fmt.Print(response)

GetTorrentCachedAvailability

Overview Takes in a list of comma separated torrent hashes and checks if the torrent is cached. This endpoint only gets a max of around 100 at a time, due to http limits in queries. If you want to do more, you can simply do more hash queries. Such as: ?hash=XXXX&hash=XXXX&hash=XXXX or ?hash=XXXX,XXXX&hash=XXXX&hash=XXXX,XXXX and this will work too. Performance is very fast. Less than 1 second per 100. Time is approximately O(log n) time for those interested in taking it to its max. That is without caching as well. This endpoint stores a cache for an hour. You may also pass a format parameter with the format you want the data in. Options are either object or list. You can view examples of both below. ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/torrents/checkcached

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
params GetTorrentCachedAvailabilityRequestParams ✅ Additional request parameters

Return Type

GetTorrentCachedAvailabilityOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
  "torbox-sdk-go/pkg/torrents"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)


params := torrents.GetTorrentCachedAvailabilityRequestParams{}


response, err := client.Torrents.GetTorrentCachedAvailability(context.Background(), "apiVersion", params)
if err != nil {
  panic(err)
}

fmt.Print(response)

SearchAllTorrentsFromScraper

Overview Uses Meilisearch to search for scraped torrents. This is a basic torrent aggregator system and has no real relation to TorBox. It is simply a tool you can use. It does not have cache information, or anything special like that, and will not have any of that information. This is simply a torrent search, nothing more. You may use this for anything. TorBox uses it in the website to make it easy for users to find torrents without having to go and find them on sketchy websites. ### Authorization None required.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/torrents/search

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
params SearchAllTorrentsFromScraperRequestParams ✅ Additional request parameters

Return Type

SearchAllTorrentsFromScraperOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
  "torbox-sdk-go/pkg/torrents"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)


params := torrents.SearchAllTorrentsFromScraperRequestParams{}


response, err := client.Torrents.SearchAllTorrentsFromScraper(context.Background(), "apiVersion", params)
if err != nil {
  panic(err)
}

fmt.Print(response)

ExportTorrentData

Overview Exports the magnet or torrent file. Requires a type to be passed. If type is magnet, it will return a JSON response with the magnet as a string in the data key. If type is file, it will return a bittorrent file as a download. Not compatible with cached downloads. ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/torrents/exportdata

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
params ExportTorrentDataRequestParams ✅ Additional request parameters

Return Type

ExportTorrentDataOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
  "torbox-sdk-go/pkg/torrents"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)


params := torrents.ExportTorrentDataRequestParams{}


response, err := client.Torrents.ExportTorrentData(context.Background(), "apiVersion", params)
if err != nil {
  panic(err)
}

fmt.Print(response)

GetTorrentInfo

Overview A general route that allows you to give a hash, and TorBox will return data about the torrent. This data is retrieved from the Bittorrent network, so expect it to take some time. If the request goes longer than 10 seconds, TorBox will cancel it. You can adjust this if you like, but the default is 10 seconds. This route is cached as well, so subsequent requests will be instant. ### Authorization None required.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/torrents/torrentinfo

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
params GetTorrentInfoRequestParams ✅ Additional request parameters

Return Type

GetTorrentInfoOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
  "torbox-sdk-go/pkg/torrents"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)


params := torrents.GetTorrentInfoRequestParams{}


response, err := client.Torrents.GetTorrentInfo(context.Background(), "apiVersion", params)
if err != nil {
  panic(err)
}

fmt.Print(response)

GetQueuedTorrents

Overview Retrieves all of a user's queued torrents. ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/torrents/getqueued

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅

Return Type

any

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)

response, err := client.Torrents.GetQueuedTorrents(context.Background(), "apiVersion")
if err != nil {
  panic(err)
}

fmt.Print(response)