This SDK is compatible with the following versions: C# >= .NET 6
To get started with the SDK, we recommend installing using nuget:
dotnet add package TorboxApiThe TorboxApi API uses an Access Token for authentication.
This token must be provided to authenticate your requests to the API.
When you initialize the SDK, you can set the access token as follows:
using TorboxApi;
using TorboxApi.Config;
var config = new TorboxApiConfig()
{
AccessToken = "YOUR_ACCESS_TOKEN"
};
var client = new TorboxApiClient(config);If you need to set or update the access token after initializing the SDK, you can use:
client.SetAccessToken("YOUR_ACCESS_TOKEN")Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
using TorboxApi;
using TorboxApi.Config;
using Environment = TorboxApi.Http.Environment;
var config = new TorboxApiConfig
{
Environment = Environment.Default,
AccessToken = "YOUR_ACCESS_TOKEN"
};
var client = new TorboxApiClient(config);
var response = await client.General.GetUpStatusAsync();
Console.WriteLine(response);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 |
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:
This SDK is licensed under the MIT License.
See the LICENSE file for more details.