@extends('layouts.main') @section('content')
Here lives the documentation for the API v2 for accessing NZB and index data. API functions can be called by providing an API token.
@auth| 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 - TVRagetvdbid=153021 - TVDBtraktid=1393 - Trakttvmazeid=73 - TVMazeimdbid=1520211 - IMDBtmdbid=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 - IMDBtmdbid=43418 - TMDBtraktid=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
|
| 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
|
All information is returned in JSON format.