https://github.com/torbox-app/torbox-sdk-py
The official TorBox SDK in Python
https://github.com/torbox-app/torbox-sdk-py
python sdk sdk-python torbox
Last synced: 11 months ago
JSON representation
The official TorBox SDK in Python
- Host: GitHub
- URL: https://github.com/torbox-app/torbox-sdk-py
- Owner: TorBox-App
- License: mit
- Created: 2024-11-24T18:48:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-08T23:05:26.000Z (11 months ago)
- Last Synced: 2025-04-14T11:56:26.563Z (11 months ago)
- Topics: python, sdk, sdk-python, torbox
- Language: Python
- Homepage: https://pypi.org/project/torbox-api
- Size: 708 KB
- Stars: 5
- Watchers: 0
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Table of Contents
- [Setup \& Configuration](#setup--configuration)
- [Supported Language Versions](#supported-language-versions)
- [Installation](#installation)
- [Authentication](#authentication)
- [Access Token Authentication](#access-token-authentication)
- [Setting the Access Token](#setting-the-access-token)
- [Setting a Custom Timeout](#setting-a-custom-timeout)
- [Sample Usage](#sample-usage)
- [Documentation](#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`:
```bash
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:
```py
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:
```py
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:
```py
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:
```py
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](documentation/services/TorrentsService.md) |
| [UsenetService](documentation/services/UsenetService.md) |
| [WebDownloadsDebridService](documentation/services/WebDownloadsDebridService.md) |
| [GeneralService](documentation/services/GeneralService.md) |
| [NotificationsService](documentation/services/NotificationsService.md) |
| [UserService](documentation/services/UserService.md) |
| [RssFeedsService](documentation/services/RssFeedsService.md) |
| [IntegrationsService](documentation/services/IntegrationsService.md) |
| [QueuedService](documentation/services/QueuedService.md) |
## 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](documentation/models/CreateTorrentRequest.md) | |
| [CreateTorrentOkResponse](documentation/models/CreateTorrentOkResponse.md) | |
| [ControlTorrentOkResponse](documentation/models/ControlTorrentOkResponse.md) | |
| [RequestDownloadLinkOkResponse](documentation/models/RequestDownloadLinkOkResponse.md) | |
| [GetTorrentListOkResponse](documentation/models/GetTorrentListOkResponse.md) | |
| [GetTorrentCachedAvailabilityOkResponse](documentation/models/GetTorrentCachedAvailabilityOkResponse.md) | |
| [ExportTorrentDataOkResponse](documentation/models/ExportTorrentDataOkResponse.md) | |
| [GetTorrentInfoOkResponse](documentation/models/GetTorrentInfoOkResponse.md) | |
| [CreateUsenetDownloadRequest](documentation/models/CreateUsenetDownloadRequest.md) | |
| [CreateUsenetDownloadOkResponse](documentation/models/CreateUsenetDownloadOkResponse.md) | |
| [GetUsenetListOkResponse](documentation/models/GetUsenetListOkResponse.md) | |
| [CreateWebDownloadRequest](documentation/models/CreateWebDownloadRequest.md) | |
| [CreateWebDownloadOkResponse](documentation/models/CreateWebDownloadOkResponse.md) | |
| [GetWebDownloadListOkResponse](documentation/models/GetWebDownloadListOkResponse.md) | |
| [GetHosterListOkResponse](documentation/models/GetHosterListOkResponse.md) | |
| [GetUpStatusOkResponse](documentation/models/GetUpStatusOkResponse.md) | |
| [GetStatsOkResponse](documentation/models/GetStatsOkResponse.md) | |
| [GetChangelogsJsonOkResponse](documentation/models/GetChangelogsJsonOkResponse.md) | |
| [GetNotificationFeedOkResponse](documentation/models/GetNotificationFeedOkResponse.md) | |
| [GetUserDataOkResponse](documentation/models/GetUserDataOkResponse.md) | |
| [AddReferralToAccountOkResponse](documentation/models/AddReferralToAccountOkResponse.md) | |
| [GetAllJobsOkResponse](documentation/models/GetAllJobsOkResponse.md) | |
| [GetAllJobsByHashOkResponse](documentation/models/GetAllJobsByHashOkResponse.md) | |