Table of Contents

Main API Examples

The Main API examples cover the largest part of the SDK surface. They are organized by resource client under the examples project.

Torrents

The torrents examples cover list, create, control, download, cache checks, and edit workflows.

Scenario Source file
List torrents ListTorrentsExample.cs
Create torrents from magnet or file CreateTorrentExample.cs
Pause, resume, or delete torrents ControlTorrentExample.cs
Download generated files DownloadTorrentExample.cs
Check cached hashes CheckCachedExample.cs
Edit torrent metadata and related workflows EditTorrentExample.cs

Usenet

Scenario Source file
List Usenet downloads ListUsenetExample.cs
Create a Usenet download CreateUsenetExample.cs
Advanced cache, edit, and async creation flows UsenetAdvancedExample.cs

Web Downloads

Scenario Source file
List web downloads ListWebDownloadsExample.cs
Create web downloads and inspect hosters CreateWebDownloadExample.cs
Cache checks, edit, and async create WebDownloadsAdvancedExample.cs

User and account workflows

These examples cover profile retrieval, settings, authentication, search engines, and billing data.

Scenario Source file
Get profile and account details GetProfileExample.cs
Edit user settings ManageSettingsExample.cs
Refresh token, device auth, confirmation, delete account flow AuthenticationExample.cs
Manage search engines SearchEnginesExample.cs
Transactions and PDF export TransactionsExample.cs

Integrations

These examples cover cloud providers, OAuth, Discord-linked roles, and background jobs.

Scenario Source file
Single cloud integration workflow CloudIntegrationExample.cs
All supported cloud providers AllCloudProvidersExample.cs
OAuth redirect, callback, register, unregister, Discord roles OAuthExample.cs
Integration job management JobManagementExample.cs

Other Main API clients

Resource area Source file
Notifications NotificationsExample.cs
RSS feeds RssFeedsExample.cs
Vendors VendorExample.cs
Queued downloads QueuedDownloadsExample.cs
Streaming media files StreamExample.cs
General service status and stats GeneralExample.cs
Speedtest and download helper files SpeedtestExample.cs

Suggested reading order

  1. Start with torrents, because they show the clearest create/list/control lifecycle.
  2. Move to user and integrations if your app needs account or provider setup.
  3. Use the advanced Usenet and web download examples when you need async or cache-oriented flows.