{"id":22864129,"url":"https://github.com/torbox-app/torbox-sdk-py","last_synced_at":"2025-04-14T11:56:44.326Z","repository":{"id":264505910,"uuid":"893559657","full_name":"TorBox-App/torbox-sdk-py","owner":"TorBox-App","description":"The official TorBox SDK in Python","archived":false,"fork":false,"pushed_at":"2025-04-08T23:05:26.000Z","size":725,"stargazers_count":5,"open_issues_count":1,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-14T11:56:26.563Z","etag":null,"topics":["python","sdk","sdk-python","torbox"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/torbox-api","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TorBox-App.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-24T18:48:11.000Z","updated_at":"2025-04-08T23:05:30.000Z","dependencies_parsed_at":"2024-11-24T23:45:19.603Z","dependency_job_id":null,"html_url":"https://github.com/TorBox-App/torbox-sdk-py","commit_stats":null,"previous_names":["torbox-app/torbox-sdk-py"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorBox-App%2Ftorbox-sdk-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorBox-App%2Ftorbox-sdk-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorBox-App%2Ftorbox-sdk-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorBox-App%2Ftorbox-sdk-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TorBox-App","download_url":"https://codeload.github.com/TorBox-App/torbox-sdk-py/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248878020,"owners_count":21176242,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","sdk","sdk-python","torbox"],"created_at":"2024-12-13T11:19:16.120Z","updated_at":"2025-04-14T11:56:44.282Z","avatar_url":"https://github.com/TorBox-App.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Logo](https://raw.githubusercontent.com/TorBox-App/torbox-sdk-py/main/assets/banner.png)\n\n## Table of Contents\n\n- [Setup \\\u0026 Configuration](#setup--configuration)\n  - [Supported Language Versions](#supported-language-versions)\n  - [Installation](#installation)\n  - [Authentication](#authentication)\n    - [Access Token Authentication](#access-token-authentication)\n      - [Setting the Access Token](#setting-the-access-token)\n  - [Setting a Custom Timeout](#setting-a-custom-timeout)\n- [Sample Usage](#sample-usage)\n  - [Documentation](#documentation)\n\n## Setup \u0026 Configuration\n\n### Supported Language Versions\n\nThis SDK is compatible with the following versions: `Python \u003e= 3.7`\n\n### Installation\n\nTo get started with the SDK, we recommend installing using `pip`:\n\n```bash\npip install torbox_api\n```\n\n## Authentication\n\n### Access Token Authentication\n\nThe TorboxApi API uses an Access Token for authentication.\n\nThis token must be provided to authenticate your requests to the API.\n\n#### Setting the Access Token\n\nWhen you initialize the SDK, you can set the access token as follows:\n\n```py\nTorboxApi(\n    access_token=\"YOUR_ACCESS_TOKEN\",\n    base_url=\"https://api.torbox.app\",\n    timeout=10000\n)\n```\n\nIf you need to set or update the access token after initializing the SDK, you can use:\n\n```py\nsdk.set_access_token(\"YOUR_ACCESS_TOKEN\")\nsdk.set_base_url(\"https://api.torbox.app\")\n```\n\n## Setting a Custom Timeout\n\nYou can set a custom timeout for the SDK's HTTP requests as follows:\n\n```py\nfrom torbox_api import TorboxApi\n\nsdk = TorboxApi(timeout=10000)\n```\n\n# Sample Usage\n\nBelow is a comprehensive example demonstrating how to authenticate and call a simple endpoint:\n\n```py\nfrom torbox_api import TorboxApi\n\nsdk = TorboxApi(\n    access_token=\"YOUR_ACCESS_TOKEN\",\n    base_url=\"https://api.torbox.app\",\n    timeout=10000\n)\n\nresult = sdk.general.get_up_status()\n\nprint(result)\n\n```\n\n## Documentation\n\nThe SDK provides various services to interact with the API.\n\n\u003cdetails\u003e \n\u003csummary\u003eBelow is a list of all available services with links to their detailed documentation:\u003c/summary\u003e\n\n| Name                                                                             |\n| :------------------------------------------------------------------------------- |\n| [TorrentsService](documentation/services/TorrentsService.md)                     |\n| [UsenetService](documentation/services/UsenetService.md)                         |\n| [WebDownloadsDebridService](documentation/services/WebDownloadsDebridService.md) |\n| [GeneralService](documentation/services/GeneralService.md)                       |\n| [NotificationsService](documentation/services/NotificationsService.md)           |\n| [UserService](documentation/services/UserService.md)                             |\n| [RssFeedsService](documentation/services/RssFeedsService.md)                     |\n| [IntegrationsService](documentation/services/IntegrationsService.md)             |\n| [QueuedService](documentation/services/QueuedService.md)                         |\n\n\u003c/details\u003e\n\n## Models\n\nThe 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.\n\n\u003cdetails\u003e \n\u003csummary\u003eBelow is a list of all available models with links to their detailed documentation:\u003c/summary\u003e\n\n| Name                                                                                                     | Description |\n| :------------------------------------------------------------------------------------------------------- | :---------- |\n| [CreateTorrentRequest](documentation/models/CreateTorrentRequest.md)                                     |             |\n| [CreateTorrentOkResponse](documentation/models/CreateTorrentOkResponse.md)                               |             |\n| [ControlTorrentOkResponse](documentation/models/ControlTorrentOkResponse.md)                             |             |\n| [RequestDownloadLinkOkResponse](documentation/models/RequestDownloadLinkOkResponse.md)                   |             |\n| [GetTorrentListOkResponse](documentation/models/GetTorrentListOkResponse.md)                             |             |\n| [GetTorrentCachedAvailabilityOkResponse](documentation/models/GetTorrentCachedAvailabilityOkResponse.md) |             |\n| [ExportTorrentDataOkResponse](documentation/models/ExportTorrentDataOkResponse.md)                       |             |\n| [GetTorrentInfoOkResponse](documentation/models/GetTorrentInfoOkResponse.md)                             |             |\n| [CreateUsenetDownloadRequest](documentation/models/CreateUsenetDownloadRequest.md)                       |             |\n| [CreateUsenetDownloadOkResponse](documentation/models/CreateUsenetDownloadOkResponse.md)                 |             |\n| [GetUsenetListOkResponse](documentation/models/GetUsenetListOkResponse.md)                               |             |\n| [CreateWebDownloadRequest](documentation/models/CreateWebDownloadRequest.md)                             |             |\n| [CreateWebDownloadOkResponse](documentation/models/CreateWebDownloadOkResponse.md)                       |             |\n| [GetWebDownloadListOkResponse](documentation/models/GetWebDownloadListOkResponse.md)                     |             |\n| [GetHosterListOkResponse](documentation/models/GetHosterListOkResponse.md)                               |             |\n| [GetUpStatusOkResponse](documentation/models/GetUpStatusOkResponse.md)                                   |             |\n| [GetStatsOkResponse](documentation/models/GetStatsOkResponse.md)                                         |             |\n| [GetChangelogsJsonOkResponse](documentation/models/GetChangelogsJsonOkResponse.md)                       |             |\n| [GetNotificationFeedOkResponse](documentation/models/GetNotificationFeedOkResponse.md)                   |             |\n| [GetUserDataOkResponse](documentation/models/GetUserDataOkResponse.md)                                   |             |\n| [AddReferralToAccountOkResponse](documentation/models/AddReferralToAccountOkResponse.md)                 |             |\n| [GetAllJobsOkResponse](documentation/models/GetAllJobsOkResponse.md)                                     |             |\n| [GetAllJobsByHashOkResponse](documentation/models/GetAllJobsByHashOkResponse.md)                         |             |\n\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorbox-app%2Ftorbox-sdk-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftorbox-app%2Ftorbox-sdk-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorbox-app%2Ftorbox-sdk-py/lists"}