torbox-api 1.0.6

You can view the full documentation at https://api-docs.torbox.app.

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
  • Authentication
    • Access Token Authentication
      • Setting the Access Token
  • Setting a Custom Timeout
• Sample Usage
  • Documentation

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install torbox_api

Authentication

Access Token Authentication

The TorboxApi API uses an Access Token for authentication.

This token must be provided to authenticate your requests to the API.

Setting the Access Token

When you initialize the SDK, you can set the access token as follows:

TorboxApi(
    access_token="YOUR_ACCESS_TOKEN",
    base_url="https://api.torbox.app",
    timeout=10000
)

If you need to set or update the access token after initializing the SDK, you can use:

sdk.set_access_token("YOUR_ACCESS_TOKEN")
sdk.set_base_url("https://api.torbox.app")

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from torbox_api import TorboxApi

sdk = TorboxApi(timeout=10000)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from torbox_api import TorboxApi

sdk = TorboxApi(
    access_token="YOUR_ACCESS_TOKEN",
    base_url="https://api.torbox.app",
    timeout=10000
)

result = sdk.general.get_up_status()

print(result)

Documentation

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:

Name
TorrentsService
UsenetService
WebDownloadsDebridService
GeneralService
NotificationsService
UserService
RssFeedsService
IntegrationsService
QueuedService

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:

Name	Description
CreateTorrentRequest
CreateTorrentOkResponse
ControlTorrentOkResponse
RequestDownloadLinkOkResponse
GetTorrentListOkResponse
GetTorrentCachedAvailabilityOkResponse
ExportTorrentDataOkResponse
GetTorrentInfoOkResponse
CreateUsenetDownloadRequest
CreateUsenetDownloadOkResponse
GetUsenetListOkResponse
CreateWebDownloadRequest
CreateWebDownloadOkResponse
GetWebDownloadListOkResponse
GetHosterListOkResponse
GetUpStatusOkResponse
GetStatsOkResponse
GetChangelogsJsonOkResponse
GetNotificationFeedOkResponse
GetUserDataOkResponse
AddReferralToAccountOkResponse
GetAllJobsOkResponse
GetAllJobsByHashOkResponse