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

{{ $title }}

Here lives the documentation for the API for accessing NZB and index data. API functions can be called by either logged in users, or by providing an API key.

@auth

Your API Credentials

@endauth

Available Functions

Use the parameter ?t= to specify the function being called.

Function Description Example
Capabilities Reports the capabilities of the server. Includes information about the server name, available search categories and version number of the newznab protocol being used.
No credentials required
?t=caps
Search Returns a list of NZBs matching a query. You can filter by site category by including a comma separated list of categories.
OPTIONS
extended=1 - Return extended information in results
@auth ?t=search&q=linux ?t=search&cat={{ $catClass::GAME_ROOT }},{{ $catClass::MOVIE_ROOT }} @else ?t=search&q=linux ?t=search&cat={{ $catClass::GAME_ROOT }},{{ $catClass::MOVIE_ROOT }} @endauth
TV Search Returns a list of NZBs matching a query, category, or TV ID. Filter by season, episode, or various database IDs.
ID OPTIONS
rid=25056 - TVRage
tvdbid=153021 - TVDB
traktid=1393 - Trakt
tvmazeid=73 - TVMaze
imdbid=1520211 - IMDB
tmdbid=1402 - TMDB
@auth ?t=tvsearch&q=law and order&season=7&ep=12 @else ?t=tvsearch&q=law and order&season=7&ep=12 @endauth
Movies Returns a list of NZBs matching a query, an IMDB ID and optionally a category.
OPTIONS
extended=1 - Return extended information in results
@auth ?t=movie&imdbid=1418646 @else ?t=movie&imdbid=1418646 @endauth
Details Returns detailed information about an NZB. @auth ?t=details&id=9ca52909ba9b9e5e6758d815fef4ecda @else ?t=details&id=<guid> @endauth
Info Returns NFO contents for an NZB. Retrieve the NFO as file by specifying o=file in the request URI. @auth ?t=info&id=9ca52909ba9b9e5e6758d815fef4ecda @else ?t=info&id=<guid> @endauth
Get Downloads the NZB file associated with an ID. @auth ?t=get&id=9ca52909ba9b9e5e6758d815fef4ecda @else ?t=get&id=<guid> @endauth

Output Format

Select your preferred output format (not applicable to functions which return an NZB/NFO file).

XML (default)

Returns the data in an XML document.

?t=search&q=linux&o=xml
JSON

Returns the data in a JSON object.

?t=search&q=linux&o=json
@endsection