Skip to content

Latest commit

 

History

History
237 lines (161 loc) · 15 KB

web_downloads_debrid_service.md

File metadata and controls

237 lines (161 loc) · 15 KB
Raw

WebDownloadsDebridService

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

Methods Description
CreateWebDownload ### Overview Creates a web download under your account. Simply send a link to any file on the internet. Once it has been checked, it 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.
ControlWebDownload ### Overview Controls a web download. By sending the web download's ID and the type of operation you want to perform, it will send that request to the debrid client. Operations are either: - Delete deletes the download from the client and your account permanently ### Authorization Requires an API key using the Authorization Bearer Header.
RequestDownloadLink2 ### 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.
GetWebDownloadList ### Overview Gets the user's web download list. This gives you the needed information to perform other usenet actions. Unlike Torrents, this information is updated on its own every 5 seconds for live web downloads. ### Authorization Requires an API key using the Authorization Bearer Header.
GetWebDownloadCachedAvailability ### Overview Takes in a list of comma separated usenet hashes and checks if the web download 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. To get the hash of a web download, pass the link through an md5 hash algo and it will return the proper hash for it. ### Authorization Requires an API key using the Authorization Bearer Header.

CreateWebDownload

Overview Creates a web download under your account. Simply send a link to any file on the internet. Once it has been checked, it 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/webdl/createwebdownload

Parameters

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

Return Type

CreateWebDownloadOkResponse

Example Usage Code Snippet

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

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


request := webdownloadsdebrid.CreateWebDownloadRequest{}
request.SetLink("Link")

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

fmt.Print(response)

ControlWebDownload

Overview Controls a web download. By sending the web download's ID and the type of operation you want to perform, it will send that request to the debrid client. Operations are either: - Delete deletes the download from the client and your account permanently ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: POST
  • Endpoint: /{api_version}/api/webdl/controlwebdownload

Parameters

Name Type Required Description
ctx Context ✅ Default go language context
apiVersion string ✅
body []byte ✅
params ControlWebDownloadRequestParams ✅ Additional request parameters

Return Type

any

Example Usage Code Snippet

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

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


params := webdownloadsdebrid.ControlWebDownloadRequestParams{}


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

fmt.Print(response)

RequestDownloadLink2

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/webdl/requestdl

Parameters

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

Return Type

any

Example Usage Code Snippet

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

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


params := webdownloadsdebrid.RequestDownloadLink2RequestParams{}


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

fmt.Print(response)

GetWebDownloadList

Overview Gets the user's web download list. This gives you the needed information to perform other usenet actions. Unlike Torrents, this information is updated on its own every 5 seconds for live web downloads. ### Authorization Requires an API key using the Authorization Bearer Header.

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

Parameters

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

Return Type

GetWebDownloadListOkResponse

Example Usage Code Snippet

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

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


params := webdownloadsdebrid.GetWebDownloadListRequestParams{}


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

fmt.Print(response)

GetWebDownloadCachedAvailability

Overview Takes in a list of comma separated usenet hashes and checks if the web download 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. To get the hash of a web download, pass the link through an md5 hash algo and it will return the proper hash for it. ### Authorization Requires an API key using the Authorization Bearer Header.

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

Parameters

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

Return Type

any

Example Usage Code Snippet

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

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


params := webdownloadsdebrid.GetWebDownloadCachedAvailabilityRequestParams{}


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

fmt.Print(response)