Prowlarr: Prowlarr API docs
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add prowlarr
pnpm add prowlarr
bun add prowlarr
yarn add prowlarr zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.
This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.
Node.js v20 or greater is required to run the MCP server from npm.
Add the following server definition to your claude_desktop_config.json file:
{
"mcpServers": {
"Prowlarr": {
"command": "npx",
"args": [
"-y", "--package", "prowlarr",
"--",
"mcp", "start",
"--x-api-key", "...",
"--apikey", "..."
]
}
}
}
Create a .cursor/mcp.json file in your project root with the following content:
{
"mcpServers": {
"Prowlarr": {
"command": "npx",
"args": [
"-y", "--package", "prowlarr",
"--",
"mcp", "start",
"--x-api-key", "...",
"--apikey", "..."
]
}
}
}
You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
curl -L -o mcp-server \
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server
If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".
{
"mcpServers": {
"Todos": {
"command": "./DOWNLOAD/PATH/mcp-server",
"args": [
"start"
]
}
}
}
For a full list of server arguments, run:
npx -y --package prowlarr -- mcp start --help
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { Prowlarr } from "prowlarr";
const prowlarr = new Prowlarr({
security: {
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
},
});
async function run() {
const result = await prowlarr.apiInfo.getApi();
console.log(result);
}
run();
This SDK supports the following security schemes globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
xApiKey | apiKey | API key | PROWLARR_X_API_KEY |
apikey | apiKey | API key | PROWLARR_APIKEY |
You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
import { Prowlarr } from "prowlarr";
const prowlarr = new Prowlarr({
security: {
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
},
});
async function run() {
const result = await prowlarr.apiInfo.getApi();
console.log(result);
}
run();
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
apiInfoGetApiapplicationDeleteApiV1ApplicationsBulkapplicationDeleteApiV1ApplicationsIdapplicationGetApiV1ApplicationsapplicationGetApiV1ApplicationsIdapplicationGetApiV1ApplicationsSchemaapplicationPostApiV1ApplicationsapplicationPostApiV1ApplicationsActionNameapplicationPostApiV1ApplicationsTestapplicationPostApiV1ApplicationsTestallapplicationPutApiV1ApplicationsBulkapplicationPutApiV1ApplicationsIdappProfileDeleteApiV1AppprofileIdappProfileGetApiV1AppprofileappProfileGetApiV1AppprofileIdappProfileGetApiV1AppprofileSchemaappProfilePostApiV1AppprofileappProfilePutApiV1AppprofileIdauthenticationGetLogoutbackupDeleteApiV1SystemBackupIdbackupGetApiV1SystemBackupbackupPostApiV1SystemBackupRestoreIdbackupPostApiV1SystemBackupRestoreUploadcommandDeleteApiV1CommandIdcommandGetApiV1CommandcommandGetApiV1CommandIdcommandPostApiV1CommandcustomFilterDeleteApiV1CustomfilterIdcustomFilterGetApiV1CustomfiltercustomFilterGetApiV1CustomfilterIdcustomFilterPostApiV1CustomfiltercustomFilterPutApiV1CustomfilterIddevelopmentConfigGetApiV1ConfigDevelopmentdevelopmentConfigGetApiV1ConfigDevelopmentIddevelopmentConfigPutApiV1ConfigDevelopmentIddownloadClientConfigGetApiV1ConfigDownloadclientdownloadClientConfigGetApiV1ConfigDownloadclientIddownloadClientConfigPutApiV1ConfigDownloadclientIddownloadClientDeleteApiV1DownloadclientBulkdownloadClientDeleteApiV1DownloadclientIddownloadClientGetApiV1DownloadclientdownloadClientGetApiV1DownloadclientIddownloadClientGetApiV1DownloadclientSchemadownloadClientPostApiV1DownloadclientdownloadClientPostApiV1DownloadclientActionNamedownloadClientPostApiV1DownloadclientTestdownloadClientPostApiV1DownloadclientTestalldownloadClientPutApiV1DownloadclientBulkdownloadClientPutApiV1DownloadclientIdfileSystemGetApiV1FilesystemfileSystemGetApiV1FilesystemTypehealthGetApiV1HealthhistoryGetApiV1HistoryhistoryGetApiV1HistoryIndexerhistoryGetApiV1HistorySincehostConfigGetApiV1ConfigHosthostConfigGetApiV1ConfigHostIdhostConfigPutApiV1ConfigHostIdindexerDefaultCategoriesGetApiV1IndexerCategoriesindexerDeleteApiV1IndexerBulkindexerDeleteApiV1IndexerIdindexerGetApiV1IndexerindexerGetApiV1IndexerIdindexerGetApiV1IndexerSchemaindexerPostApiV1IndexerindexerPostApiV1IndexerActionNameindexerPostApiV1IndexerTestindexerPostApiV1IndexerTestallindexerProxyDeleteApiV1IndexerproxyIdindexerProxyGetApiV1IndexerproxyindexerProxyGetApiV1IndexerproxyIdindexerProxyGetApiV1IndexerproxySchemaindexerProxyPostApiV1IndexerproxyindexerProxyPostApiV1IndexerproxyActionNameindexerProxyPostApiV1IndexerproxyTestindexerProxyPostApiV1IndexerproxyTestallindexerProxyPutApiV1IndexerproxyIdindexerPutApiV1IndexerBulkindexerPutApiV1IndexerIdindexerStatsGetApiV1IndexerstatsindexerStatusGetApiV1IndexerstatuslocalizationGetApiV1LocalizationlocalizationGetApiV1LocalizationOptionslogFileGetApiV1LogFilelogFileGetApiV1LogFileFilenamelogGetApiV1LognewznabGetApiV1IndexerIdDownloadnewznabGetApiV1IndexerIdNewznabnewznabGetIdApinewznabGetIdDownloadnotificationDeleteApiV1NotificationIdnotificationGetApiV1NotificationnotificationGetApiV1NotificationIdnotificationGetApiV1NotificationSchemanotificationPostApiV1NotificationnotificationPostApiV1NotificationActionNamenotificationPostApiV1NotificationTestnotificationPostApiV1NotificationTestallnotificationPutApiV1NotificationIdpingGetPingpingHeadPingsearchGetApiV1SearchsearchPostApiV1SearchsearchPostApiV1SearchBulkstaticResourceGetstaticResourceGetContentPathstaticResourceGetLoginstaticResourceGetPathsystemGetApiV1SystemRoutessystemGetApiV1SystemRoutesDuplicatesystemGetApiV1SystemStatussystemPostApiV1SystemRestartsystemPostApiV1SystemShutdowntagDeleteApiV1TagIdtagDetailsGetApiV1TagDetailtagDetailsGetApiV1TagDetailIdtagGetApiV1TagtagGetApiV1TagIdtagPostApiV1TagtagPutApiV1TagIdtaskGetApiV1SystemTasktaskGetApiV1SystemTaskIduiConfigGetApiV1ConfigUiuiConfigGetApiV1ConfigUiIduiConfigPutApiV1ConfigUiIdupdateGetApiV1UpdateupdateLogFileGetApiV1LogFileUpdateupdateLogFileGetApiV1LogFileUpdateFilenameSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { Prowlarr } from "prowlarr";
const prowlarr = new Prowlarr({
security: {
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
},
});
async function run() {
const result = await prowlarr.apiInfo.getApi({
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { Prowlarr } from "prowlarr";
const prowlarr = new Prowlarr({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
security: {
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
},
});
async function run() {
const result = await prowlarr.apiInfo.getApi();
console.log(result);
}
run();
ProwlarrError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
|---|---|---|
error.message | string | Error message |
error.statusCode | number | HTTP response status code eg 404 |
error.headers | Headers | HTTP response headers |
error.body | string | HTTP body. Can be empty string if no body is returned. |
error.rawResponse | Response | Raw HTTP response |
import { Prowlarr } from "prowlarr";
import * as errors from "prowlarr/models/errors";
const prowlarr = new Prowlarr({
security: {
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
},
});
async function run() {
try {
const result = await prowlarr.apiInfo.getApi();
console.log(result);
} catch (error) {
if (error instanceof errors.ProwlarrError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
}
}
}
run();
Primary error:
ProwlarrError: The base class for HTTP error responses.Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.Inherit from ProwlarrError:
ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.The default server {protocol}://{hostpath} contains variables and is set to http://localhost:9696 by default. To override default values, the following parameters are available when initializing the SDK client instance:
| Variable | Parameter | Supported Values | Default | Description |
|---|---|---|---|---|
protocol | protocol: models.ServerProtocol | - "http"- "https" | "http" | |
hostpath | hostpath: string | string | "localhost:9696" |
import { Prowlarr } from "prowlarr";
const prowlarr = new Prowlarr({
protocol: "https",
hostpath: "<value>",
security: {
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
},
});
async function run() {
const result = await prowlarr.apiInfo.getApi();
console.log(result);
}
run();
The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { Prowlarr } from "prowlarr";
const prowlarr = new Prowlarr({
serverURL: "http://localhost:9696",
security: {
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
},
});
async function run() {
const result = await prowlarr.apiInfo.getApi();
console.log(result);
}
run();
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { Prowlarr } from "prowlarr";
import { HTTPClient } from "prowlarr/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Prowlarr({ httpClient });
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { Prowlarr } from "prowlarr";
const sdk = new Prowlarr({ debugLogger: console });
You can also enable a default debug logger by setting an environment variable PROWLARR_DEBUG to true.
FAQs
<!-- Start Summary [summary] --> ## Summary
We found that prowlarr demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.