> ## Documentation Index
> Fetch the complete documentation index at: https://docs.torrin.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Newznab indexer

> Exposes Torrin's Usenet search as a Newznab indexer for Prowlarr, NZBHydra2, Jackett, and the *arr apps. Add as a "Generic Newznab" indexer with base URL `/newznab` and your Torrin API key. Returns a Newznab RSS/XML feed (or caps XML).




## OpenAPI

````yaml /api-reference/openapi.yaml get /newznab/api
openapi: 3.0.3
info:
  title: Torrin API
  version: 1.0.0
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.en.html
  description: >
    Torrin's HTTP API has two halves:


    - The **native app API** under `/api` — the job engine, search,
    availability,
      bring-your-own-key debrid, bring-your-own-storage, Usenet, Cairn, and RSS. This is
      "torrin's own API"; it takes and returns torrin's own JSON.
    - Two **compatibility surfaces** for existing clients: a
    **RealDebrid-compatible** API
      under `/rest/1.0` (Stremio RD addons) and a **StremThru store** API under `/v0/store`
      (clients like Comet).

    All authenticated endpoints use your instance **API key** as a bearer token.
servers:
  - url: https://api.torrin.app
    description: Hosted torrin (api.torrin.app)
  - url: '{baseUrl}'
    description: Your self-hosted instance
    variables:
      baseUrl:
        default: https://api.torrin.app
        description: The base URL of your torrin instance
security:
  - bearerAuth: []
tags:
  - name: Account
    description: The authenticated user and account management.
  - name: Auth
    description: Login, sessions, two-factor, and API keys.
  - name: Wallet
    description: Prepaid balance, top-ups, and buying plans.
  - name: Jobs
    description: The download engine. Add a source, track it, stream the result.
  - name: Search & availability
    description: Find content and check whether it's already cached.
  - name: Debrid keys
    description: Bring your own RealDebrid / AllDebrid / Premiumize / TorBox key (BYOK).
  - name: Storage
    description: Bring your own storage to stream from your own cloud (BYOS).
  - name: Usenet
    description: Usenet provider, indexer, search, and grabs.
  - name: Telegram
    description: Link the account to the Telegram bot.
  - name: Billing
    description: Checkouts and code redemption.
  - name: Cairn
    description: Permanent Usenet-backed archive of cached content.
  - name: RSS
    description: Auto-add feeds.
  - name: RealDebrid-compatible
    description: RealDebrid API shapes under /rest/1.0, for RD clients and Stremio addons.
  - name: StremThru store
    description: StremThru store API under /v0/store, for clients like Comet.
  - name: Public
    description: Unauthenticated endpoints for signup and instance metadata.
  - name: WebDAV
    description: Per-release naming overrides for the WebDAV library.
  - name: Download client
    description: >-
      qBittorrent- and SABnzbd-compatible endpoints so Sonarr/Radarr can use
      Torrin as a download client.
paths:
  /newznab/api:
    get:
      tags:
        - Search & availability
      summary: Newznab indexer
      description: >
        Exposes Torrin's Usenet search as a Newznab indexer for Prowlarr,
        NZBHydra2, Jackett, and the *arr apps. Add as a "Generic Newznab"
        indexer with base URL `/newznab` and your Torrin API key. Returns a
        Newznab RSS/XML feed (or caps XML).
      operationId: newznab
      parameters:
        - name: t
          in: query
          required: true
          description: 'Function: caps, search, tvsearch, or movie.'
          schema:
            type: string
            enum:
              - caps
              - search
              - tvsearch
              - movie
        - name: apikey
          in: query
          description: Your Torrin API key (required for search; not needed for caps).
          schema:
            type: string
        - name: q
          in: query
          description: Text query (search).
          schema:
            type: string
        - name: imdbid
          in: query
          description: IMDb id, digits only (tvsearch/movie).
          schema:
            type: string
        - name: season
          in: query
          schema:
            type: integer
        - name: ep
          in: query
          schema:
            type: integer
        - name: cat
          in: query
          description: Category filter (2000 movies, 5000 TV).
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: integer
        - name: offset
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: Newznab RSS/XML feed, or capabilities XML for t=caps.
          content:
            application/rss+xml:
              schema:
                type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Your instance API key as a bearer token: `Authorization: Bearer
        <api_key>`.

        `/rest/1.0` also accepts `?auth_token=`; `/v0/store` also accepts

        `X-StremThru-Store-Authorization: Bearer <api_key>`.

````