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 apikey.
Use the parameter ?t= to specify the function being called.
Reports the capabilities if the server. Includes information about the server name, available search categories and version number of the newznab protocol being used.
Capabilities does not require any credentials in order to be ran.
Register ?t=register&[email protected]
Registers a new user account. Does not require any credentials in order to be ran.
Returns either the registered username and password if successful or an error code.
Returns public information about a user.
Returns either the user information or an error code.
Returns the items in a users cart in the form of an rss feed. The optional parameter &del=1 will remove the items from the cart after the feed is requested.
Adds an nzb to a users cart.
Remove an nzb from a users cart.
Returns a list of nzbs matching a query. You can also filter by site category or group name by including a comma separated list as follows ?t=search&cat=1000,2000&group=a.b.multimedia. Include &extended=1 to return extended information in the search results.
Returns a list of nzbs matching a query, category, tvrageid, season or episode. You can also filter by site category by including a comma separated list of categories as follows ?t=tvsearch&rid=2204&cat=1000,2000. Include &extended=1 to return extended information in the search results.
Returns a list of nzbs matching a query, an imdbid and optionally a category or genre. Filter by site category by including a comma separated list of categories as follows ?t=movie&imdbid=0023010&cat=2030,2040&genre=Romance. Include &extended=1 to return extended information in the search results.
Returns a list of nzbs matching an audio based query and optionally a category. Filter by site category by including a comma separated list of categories as follows ?t=music&artist=Jack&cat=2030,2040. Include &extended=1 to return extended information in the search results. Other search parameters include artist, album, label, year, genre (supports comma separated list).
Returns a list of nzbs matching a book based query. Include &extended=1 to return extended information in the search results. Other search parameters include title.
Returns detailed information about an nzb.
Returns an nfo file for an nzb. Optional parameter &raw=1 returns just the nfo file without the rss container.
Returns comments for an nzb.
Downloads the nzb file associated with an Id.
Adds a comment to an nzb.
Obviously not appropriate to functions which return an nzb file.
Xml (default) ?t=search&q=linux&o=xml
Returns the data in an xml document.
Returns the data in a json object.
Using the attrs tag and a comma separated list of supported values, extended information can be returned in the search results.
For example ?attrs=files,poster,group. Note that not every attribute is available for every release type. Below is a list of some of the supported attributes. To return all known attributes per release use the parameter ?extended=1. See the API specification for a full list.