{"_id":"@torbox/torbox-api","_rev":"7-1d5daf8cdeb03846b8e1c99ebbd9d86b","name":"@torbox/torbox-api","dist-tags":{"latest":"1.0.9"},"versions":{"1.0.2":{"name":"@torbox/torbox-api","version":"1.0.2","keywords":["typescript","sdk","api","client"],"author":"","license":"MIT","_id":"@torbox/torbox-api@1.0.2","maintainers":[{"name":"torbox","email":"wamy@torbox.app"}],"dist":{"shasum":"c56deac59aabe6881d492d41576d6a1c7d8df4fb","tarball":"https://registry.npmjs.org/@torbox/torbox-api/-/torbox-api-1.0.2.tgz","fileCount":6,"integrity":"sha512-ZheZdl6B96vGMDO0yuoElvJWC+kKpEyWlXjzP41p00BO0Xw4sMC7K8jknWmDhSKwlDAIsFEQF4vi1QyHWrfnFg==","signatures":[{"sig":"MEYCIQCJoXatqiiHlu2ELX7N3vD6TfR/fEforO+Giizo0jDiXAIhAPhJ1C2vUO87fYULtHi71MLLUoASLktr2WpCuYEltOAq","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":508729},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"a49fbe0afadfe75ed488fe997a5ce4e3ed6e0571","scripts":{"test":"tsc --noEmit","build":"tsup-node src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"_npmUser":{"name":"torbox","email":"wamy@torbox.app"},"_npmVersion":"10.9.0","description":"You can read the full documentation at https://api-docs.torbox.app!","directories":{},"_nodeVersion":"20.14.0","dependencies":{"zod":"3.22.0"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^6.7.0","typescript":"5.3.3"},"_npmOperationalInternal":{"tmp":"tmp/torbox-api_1.0.2_1732482112348_0.35215798878503657","host":"s3://npm-registry-packages"}},"1.0.3":{"name":"@torbox/torbox-api","version":"1.0.3","keywords":["typescript","sdk","api","client"],"author":"","license":"MIT","_id":"@torbox/torbox-api@1.0.3","maintainers":[{"name":"torbox","email":"wamy@torbox.app"}],"dist":{"shasum":"c00c235269a251f73e5bb441b04ec6fd61f34346","tarball":"https://registry.npmjs.org/@torbox/torbox-api/-/torbox-api-1.0.3.tgz","fileCount":6,"integrity":"sha512-IckNuJuDe4cTy74rdkQlbee8yv0s3Oh+frYbO2DLJ5D6T6AO0/KojCZXPnjkbKpvorhb7JFro0dBunpz8lGjUA==","signatures":[{"sig":"MEUCIQCWfsgnpc+xTeBaX0EFJs3yJcLQraw+5oIFudiGTl5jMAIgMmZRYHyuwMntxzgr6lQJ0BD/gbC1i5njLxAu4MOMSDQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":508724},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"5c85a3968e88758bb37a25727cc803de786f722d","scripts":{"test":"tsc --noEmit","build":"tsup-node src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"_npmUser":{"name":"torbox","email":"wamy@torbox.app"},"_npmVersion":"10.9.0","description":"You can view the full documentation at https://api-docs.torbox.app.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"zod":"3.22.0"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^6.7.0","typescript":"5.3.3"},"_npmOperationalInternal":{"tmp":"tmp/torbox-api_1.0.3_1732483142737_0.10810315252126279","host":"s3://npm-registry-packages"}},"1.0.4":{"name":"@torbox/torbox-api","version":"1.0.4","keywords":["typescript","sdk","api","client"],"author":"","license":"MIT","_id":"@torbox/torbox-api@1.0.4","maintainers":[{"name":"torbox","email":"wamy@torbox.app"}],"dist":{"shasum":"d039359ce6d27aa048fa569f74906f8187f95eec","tarball":"https://registry.npmjs.org/@torbox/torbox-api/-/torbox-api-1.0.4.tgz","fileCount":6,"integrity":"sha512-aNa5Ne7kfKQxTxaVc8BbCpMzfZHrID3+KRnwfaCiTE2LJoRL5gdqd1p+4T+bE63iJxU3uehS5/+k/U2P6PqNqA==","signatures":[{"sig":"MEYCIQCJmZolNjdLNhT4eSXr/Z+AedsnUBQN+6rDP6CYot5RIgIhAKuu1m2S3k8rUPzbpuxPF6vBNHCJjaGW7LHOPXISbqVe","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":508539},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"8ad536cd86c50e7a1dff893515c3840f158fdd33","scripts":{"test":"tsc --noEmit","build":"tsup-node src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"_npmUser":{"name":"torbox","email":"wamy@torbox.app"},"_npmVersion":"10.9.0","description":"You can view the full documentation at https://api-docs.torbox.app.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"zod":"3.22.0"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^6.7.0","typescript":"5.3.3"},"_npmOperationalInternal":{"tmp":"tmp/torbox-api_1.0.4_1732498152642_0.7046070041491919","host":"s3://npm-registry-packages"}},"1.0.5":{"name":"@torbox/torbox-api","version":"1.0.5","keywords":["typescript","sdk","api","client"],"author":"","license":"MIT","_id":"@torbox/torbox-api@1.0.5","maintainers":[{"name":"torbox","email":"wamy@torbox.app"}],"dist":{"shasum":"fffab3a0f4fce74f6630c590b78afa09079553f3","tarball":"https://registry.npmjs.org/@torbox/torbox-api/-/torbox-api-1.0.5.tgz","fileCount":6,"integrity":"sha512-HHjzdIu2JwZz8y4aARph8KwRAtCXAlTNM8Z/XBxIlxcdl/L97oMkVDQ+hKS+IdfinHwd/3BjCvUbwtQUN1i0yA==","signatures":[{"sig":"MEUCIQD4Uj4BYCqbrfYWReVKMHJ2GMYSCZN1XQuzf3Mb0ClXwwIgHIZG/V7FqISdYEMk8yNjlWZtmHRYd4eZCIxl5lkrzYM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":508356},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"9c2eb7f84f707a77fc45263c2d8c973fa968ab7d","scripts":{"test":"tsc --noEmit","build":"tsup-node src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"_npmUser":{"name":"torbox","email":"wamy@torbox.app"},"_npmVersion":"10.9.0","description":"You can view the full documentation at https://api-docs.torbox.app.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"zod":"3.22.0"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^6.7.0","typescript":"5.3.3"},"_npmOperationalInternal":{"tmp":"tmp/torbox-api_1.0.5_1732499895635_0.6924189641038134","host":"s3://npm-registry-packages"}},"1.0.6":{"name":"@torbox/torbox-api","version":"1.0.6","keywords":["typescript","sdk","api","client"],"author":"","license":"MIT","_id":"@torbox/torbox-api@1.0.6","maintainers":[{"name":"torbox","email":"wamy@torbox.app"}],"dist":{"shasum":"4a8f9a3ea44b8c7dad547a66fe9563c86195bd1d","tarball":"https://registry.npmjs.org/@torbox/torbox-api/-/torbox-api-1.0.6.tgz","fileCount":6,"integrity":"sha512-i/eQw1stfy1Vzd49vzpri4+8c+jYNFZKNTyRqBSFcTq9T8XzaIgPuHJaAjt3Y2E+IY+YtNbvR6RiXm63fam4Rg==","signatures":[{"sig":"MEQCIBPcihHk1hivXMuEQoxuGg+6N6bYBO/H7vwexplcJ7GlAiAOiBb331d+2t9VStMSoTVIVbEkSGuTCvShf8WmoNSm/w==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":487366},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"66134339460be76170f867083c5b3dbeec56587a","scripts":{"test":"tsc --noEmit","build":"tsup-node src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"_npmUser":{"name":"torbox","email":"wamy@torbox.app"},"_npmVersion":"10.9.0","description":"You can view the full documentation at https://api-docs.torbox.app.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"zod":"3.22.0"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^6.7.0","typescript":"5.3.3"},"_npmOperationalInternal":{"tmp":"tmp/torbox-api_1.0.6_1732575140769_0.42208609082083726","host":"s3://npm-registry-packages"}},"1.0.8":{"name":"@torbox/torbox-api","version":"1.0.8","keywords":["typescript","sdk","api","client"],"author":"","license":"MIT","_id":"@torbox/torbox-api@1.0.8","maintainers":[{"name":"torbox","email":"wamy@torbox.app"}],"dist":{"shasum":"4de413d4cc75f721a63d585201844133397cd2db","tarball":"https://registry.npmjs.org/@torbox/torbox-api/-/torbox-api-1.0.8.tgz","fileCount":6,"integrity":"sha512-zh2sQzbdr8gKjp/sctWNOSccE4JufBOykhaBmpL/pPcjI/93EwlZ6JzFUlt1EjPZOlJJF2apebCIHDX7gg/+/A==","signatures":[{"sig":"MEQCIH2/atdOL97Qx8KgK3pYE6ZCN+ONPztb6saBrrG2KnWmAiBv+jQXs0S/rrZUYKxFkoHivddDucrRRDSoCp5cvAJZOw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":535924},"main":"./dist/index.js","types":"./dist/index.d.ts","unpkg":"./dist/index.js","module":"./dist/index.mjs","source":"./src/index.ts","browser":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"06b3da38dc1edd22eace8fa3b41502cdc36e41ca","scripts":{"test":"tsc --noEmit","build":"tsup-node src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"_npmUser":{"name":"torbox","email":"wamy@torbox.app"},"_npmVersion":"10.9.0","description":"You can view the full documentation at https://api-docs.torbox.app.","directories":{},"_nodeVersion":"20.14.0","dependencies":{"zod":"3.22.0"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^6.7.0","typescript":"5.3.3"},"_npmOperationalInternal":{"tmp":"tmp/torbox-api_1.0.8_1738124562724_0.8064009360421676","host":"s3://npm-registry-packages-npm-production"}},"1.0.9":{"name":"@torbox/torbox-api","version":"1.0.9","description":"You can view the full documentation at https://api-docs.torbox.app.","source":"./src/index.ts","main":"./dist/index.js","module":"./dist/index.mjs","browser":"./dist/index.js","unpkg":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"test":"tsc --noEmit","build":"tsup-node src/index.ts --format cjs,esm --dts --clean","prepublishOnly":"npm run build"},"keywords":["typescript","sdk","api","client"],"author":"","license":"MIT","devDependencies":{"typescript":"5.3.3","@types/node":"^22.13.9","tsup":"^6.7.0"},"dependencies":{"zod":"3.22.0"},"exports":{".":{"require":"./dist/index.js","import":"./dist/index.js","types":"./dist/index.d.ts"}},"_id":"@torbox/torbox-api@1.0.9","gitHead":"d39a69017c9ab5c9cced90e61b2fe998b8ebd454","_nodeVersion":"20.14.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-Lle2A5RU/Rps6aBqv1/QYtfEr6/wvC7rFYi7taoBYj11HlfK74Gj1YM46dfRk/xqgoUfv6OHv0IIO/f3y7R6wQ==","shasum":"4e6f9ec6131c85b455715aadae1daed9a8507290","tarball":"https://registry.npmjs.org/@torbox/torbox-api/-/torbox-api-1.0.9.tgz","fileCount":6,"unpackedSize":666550,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQChREcJYieErhuvuQCDC87ep8J2n9/4vK1uWa8DKS6uXwIgXt0xA1XhsRmQv/ZreBxaQWSrwxdrcX+hVynK0wp/84A="}]},"_npmUser":{"name":"torbox","email":"wamy@torbox.app"},"directories":{},"maintainers":[{"name":"torbox","email":"wamy@torbox.app"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/torbox-api_1.0.9_1745658508908_0.1481331985467791"},"_hasShrinkwrap":false}},"time":{"created":"2024-11-24T21:01:52.268Z","modified":"2025-04-26T09:08:29.318Z","1.0.2":"2024-11-24T21:01:52.577Z","1.0.3":"2024-11-24T21:19:03.027Z","1.0.4":"2024-11-25T01:29:12.837Z","1.0.5":"2024-11-25T01:58:15.812Z","1.0.6":"2024-11-25T22:52:20.943Z","1.0.8":"2025-01-29T04:22:42.963Z","1.0.9":"2025-04-26T09:08:29.114Z"},"license":"MIT","keywords":["typescript","sdk","api","client"],"description":"You can view the full documentation at https://api-docs.torbox.app.","maintainers":[{"name":"torbox","email":"wamy@torbox.app"}],"readme":"![Logo](https://raw.githubusercontent.com/TorBox-App/torbox-sdk-js/main/assets/banner.png)\n\n## Table of Contents\n\n- [Setup \\& 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 - [Models](#models)\n\n# Setup & Configuration\n\n## Supported Language Versions\n\nThis SDK is compatible with the following versions: `TypeScript >= 4.8.4`\n\n## Installation\n\nTo get started with the SDK, we recommend installing using `pnpm`:\n\n```bash\npnpm install @torbox/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 as well as a few more variables:\n\n```ts\nconst sdk = new TorboxApi({ token: 'YOUR_TOKEN', baseUrl: 'https://api.torbox.app' });\n```\n\nIf you need to set or update the access token after initializing the SDK, you can use:\n\n```ts\nconst sdk = new TorboxApi();\nsdk.token = 'YOUR_TOKEN';\nsdk.baseUrl = '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```ts\nconst torboxApi = new 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```ts\nimport { TorboxApi } from '@torbox/torbox-api';\n\n(async () => {\n const torboxApi = new TorboxApi({\n token: 'YOUR_TOKEN',\n baseUrl: 'https://api.torbox.app';\n });\n\n const { data } = await torboxApi.general.getUpStatus();\n\n console.log(data);\n})();\n```\n\n## Documentation\n\nThe SDK provides various services to interact with the API.\n\n
\nBelow is a list of all available services with links to their detailed documentation:\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\n
\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
\nBelow is a list of all available models with links to their detailed documentation:\n\n| Name | Description |\n| :------------------------------------------------------------------------------------------------------- | :---------- |\n| [CreateTorrentRequest](documentation/models/CreateTorrentRequest.md) | |\n| [CreateTorrentOkResponse](documentation/models/CreateTorrentOkResponse.md) | |\n| [ControlTorrentOkResponse](documentation/models/ControlTorrentOkResponse.md) | |\n| [ControlQueuedTorrentOkResponse](documentation/models/ControlQueuedTorrentOkResponse.md) | |\n| [RequestDownloadLinkOkResponse](documentation/models/RequestDownloadLinkOkResponse.md) | |\n| [GetTorrentListOkResponse](documentation/models/GetTorrentListOkResponse.md) | |\n| [GetTorrentCachedAvailabilityOkResponse](documentation/models/GetTorrentCachedAvailabilityOkResponse.md) | |\n| [SearchAllTorrentsFromScraperOkResponse](documentation/models/SearchAllTorrentsFromScraperOkResponse.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| [GetUpStatusOkResponse](documentation/models/GetUpStatusOkResponse.md) | |\n| [GetStatsOkResponse](documentation/models/GetStatsOkResponse.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
\n","readmeFilename":"README.md"}