@extends('layouts.main') @section('content')

{{ $title }}

Here lives the documentation for the API v2 for accessing NZB and index data. API functions can be called by providing an API token.

The capabilities endpoint is public. Other v2 endpoints return JSON errors with matching HTTP statuses: 400 for missing api_token, 401 for invalid or unverified tokens, 403 for suspended accounts, and 429 for request limits.

@auth

Your API Credentials

@endauth

Available Functions

Beyond search, tv, and movies, JSON endpoints include audio (music), books, and anime. The capabilities response lists audio-search, book-search, and anime-search.

Function Description Example
Capabilities Reports the capabilities of the server. Includes information about the server name, available search categories and version number of the nntmux being used.
No credentials required
capabilities
Search Returns a list of NZBs matching a query. You can filter by site category by including a comma separated list of categories.
@auth search?id=linux search?cat={{ $catClass::GAME_ROOT }},{{ $catClass::MOVIE_ROOT }} @else search?id=linux search?cat={{ $catClass::GAME_ROOT }},{{ $catClass::MOVIE_ROOT }} @endauth
TV Search Returns a list of NZBs matching a query, category, TVRageID, season or episode.
ID OPTIONS
rid=25056 - TVRage
tvdbid=153021 - TVDB
traktid=1393 - Trakt
tvmazeid=73 - TVMaze
imdbid=1520211 - IMDB
tmdbid=1402 - TMDB
@auth tv?id=law and order&season=7&ep=12 tv?rid=2204&cat={{ $catClass::GAME_ROOT }},{{ $catClass::MOVIE_ROOT }} @else tv?id=law and order&season=7&ep=12 tv?rid=2204&cat={{ $catClass::GAME_ROOT }},{{ $catClass::MOVIE_ROOT }} @endauth
Movies Returns a list of NZBs matching a query, an ID (IMDB, TMDB, or Trakt) and optionally a category.
ID OPTIONS
imdbid=1418646 - IMDB
tmdbid=43418 - TMDB
traktid=29200 - Trakt
@auth movies?imdbid=1418646 movies?imdbid=1418646&cat={{ $catClass::MOVIE_SD }},{{ $catClass::MOVIE_HD }} @else movies?imdbid=1418646 movies?imdbid=1418646&cat={{ $catClass::MOVIE_SD }},{{ $catClass::MOVIE_HD }} @endauth
Audio (music) Music search: pass the text query as id (same pattern as search). Optional: cat, maxage, minsize, group, offset/limit. @auth audio?id=…&cat={{ $catClass::MUSIC_ROOT }} @else audio?id=<artist or title>&cat={{ $catClass::MUSIC_ROOT }} @endauth
Books Book search: query text in id. Optional cat, maxage, minsize, group. @auth books?id=…&cat={{ $catClass::BOOKS_ROOT }} @else books?id=<author or title>&cat={{ $catClass::BOOKS_ROOT }} @endauth
Anime Provide at least one of: id (title search), anidbid, or anilistid. Optional: cat, maxage.
@auth anime?id=attack on titan anime?anilistid=21 @else anime?id=<title> anime?anidbid=<id> or anime?anilistid=<id> @endauth
Details Returns detailed information about an NZB. @auth details?id=9ca52909ba9b9e5e6758d815fef4ecda @else details?id=<guid> @endauth
Get NZB Downloads the NZB file associated with an ID. @auth getnzb?id=9ca52909ba9b9e5e6758d815fef4ecda @else getnzb?id=<guid> @endauth

Sorting Results (v2)

Search endpoints support sort=field_direction. Allowed fields: cat, name, size, files, stats, posted. Direction is asc or desc.

Sort request examples
@auth search?id=ubuntu&sort=posted_desc search?id=ubuntu&sort=name_asc movies?imdbid=1418646&sort=size_desc @else search?id=ubuntu&sort=posted_desc search?id=ubuntu&sort=name_asc movies?imdbid=1418646&sort=size_desc @endauth
JSON sort response snippet (sort=size_desc)
{
  "Total": 2,
  "Results": [
    { "title": "Ubuntu ISO x64", "size": 734003200 },
    { "title": "Ubuntu ISO x86", "size": 367001600 }
  ]
}

Results are largest-to-smallest when sort=size_desc.

Output Format

JSON Format

All information is returned in JSON format.

Note: When using these API endpoints in your applications, always send your API token with each request.
@endsection