@extends('layouts.main') @section('content')
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.
@if($loggedin ?? false)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
|
@if($loggedin ?? false)
?t=search&q=linux
?t=search&cat={{ $catClass::GAME_ROOT }},{{ $catClass::MOVIE_ROOT }}
@endif
|
| 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 - TVRagetvdbid=153021 - TVDBtraktid=1393 - Trakttvmazeid=73 - TVMazeimdbid=1520211 - IMDBtmdbid=1402 - TMDB
|
@if($loggedin ?? false)
?t=tvsearch&q=law and order&season=7&ep=12
@endif
|
| Movies |
Returns a list of NZBs matching a query, an IMDB ID and optionally a category.
OPTIONS
extended=1 - Return extended information in results
|
@if($loggedin ?? false)
?t=movie&imdbid=1418646
@endif
|
| Details | Returns detailed information about an NZB. |
@if($loggedin ?? false)
?t=details&id=9ca52909ba9b9e5e6758d815fef4ecda
@endif
|
| Info | Returns NFO contents for an NZB. Retrieve the NFO as file by specifying o=file in the request URI. |
@if($loggedin ?? false)
?t=info&id=9ca52909ba9b9e5e6758d815fef4ecda
@endif
|
| Get | Downloads the NZB file associated with an ID. |
@if($loggedin ?? false)
?t=get&id=9ca52909ba9b9e5e6758d815fef4ecda
@endif
|
Select your preferred output format (not applicable to functions which return an NZB/NFO file).
Returns the data in an XML document.
?t=search&q=linux&o=xml
Returns the data in a JSON object.
?t=search&q=linux&o=json