@extends('layouts.main') @section('content')
Here lives the documentation for the API for accessing NZB and index data. API functions require your API key
except public capabilities; direct /getnzb
downloads may also use your logged-in browser session.
XML error responses include a <error code="...">
body and use matching HTTP statuses such as 400 for missing/incorrect parameters, 401 for invalid credentials,
403 for suspended accounts, 404 for missing functions/items, and 429 for request or download limits.
Use the parameter ?t= to specify the function being called. In addition to search, TV, and movies, this site supports music (t=music or t=audio), books (t=book or t=b), and anime (t=anime). See ?t=caps for capability flags.
| 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 - TVRagetvdbid=153021 - TVDBtraktid=1393 - Trakttvmazeid=73 - TVMazeimdbid=1520211 - IMDBtmdbid=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
|
| Music / Audio |
Returns NZBs in music categories matching artist/title text (q).
Same as general search, you may filter by category, age, size, and group.
ALIASES
t=music or t=audio
|
@auth
?t=music&q=…&cat={{ $catClass::MUSIC_ROOT }}
@else
?t=music&q=<artist or title>&cat={{ $catClass::MUSIC_ROOT }}
@endauth
|
| Books |
Returns NZBs in book categories matching author/title text (q).
Optional filters: category, maxage, minsize, group.
ALIASES
t=book or t=b
|
@auth
?t=book&q=…&cat={{ $catClass::BOOKS_ROOT }}
@else
?t=book&q=<author or title>&cat={{ $catClass::BOOKS_ROOT }}
@endauth
|
| Anime |
Returns NZBs in anime categories. Provide a title search (q), internal anidbid, and/or anilistid (at least one required).
Optional: cat, maxage.
|
@auth
?t=anime&q=attack on titan
?t=anime&anilistid=21
@else
?t=anime&q=<title>
?t=anime&anidbid=<id> or ?t=anime&anilistid=<id>
@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
|
Search-style endpoints support sort=field_direction.
Allowed fields: cat, name, size, files, stats, posted. Direction is asc or desc.
?t=search&q=ubuntu&sort=posted_desc
?t=search&q=ubuntu&sort=name_asc
?t=search&q=ubuntu&sort=size_desc&limit=50
@else
?t=search&q=ubuntu&sort=posted_desc
?t=search&q=ubuntu&sort=name_asc
?t=search&q=ubuntu&sort=size_desc&limit=50&offset=0
@endauth
sort=size_desc)<item>
<title>Ubuntu ISO x64</title>
<newznab:attr name="size" value="734003200"/>
</item>
<item>
<title>Ubuntu ISO x86</title>
<newznab:attr name="size" value="367001600"/>
</item>
Larger release appears first because size_desc sorts descending.
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