omg ap

----------------------------------API DOC----------------------------------

Information
These notes relate to v2.0 of our API

To access the API you will need an API Key. This can be found in Here

*A VIP Account is Required*

You should use the HTTPS GET method for sending queries to the sever. POST method is not supported.
ANY Abuse of the API will result in an API ban, and or further restrictions.
We reserve the right to ban any user(s), IP(s) etc without notice, if in breach of the above.


API Rate Limits:
We have a "Daily Requests" and a "Daily Download" limit. These couters are updated daily.

The current rate limits are as follows:
DAILY REQUESTS LIMITATION: tbc!
DAILY DOWNLOAD LIMITATION: tbc!


JSON Search API
url to use:

https://api.omgwtfnzbs.org/json/?search={some search term}&user={username}&api={apikey}

variables:

* ?search=something = No terms no search!
* &user={username} = Your account username.
* &api={apikey} = Your API Key.
* &catid=1,2,3 ect = Optional, search multiple categorys.
* &retention={days} = Optional, limit the search to X amount of days ago.
* &eng=1 = Optional, return only english/unknown posts.

example api Call:

https://api.omgwtfnzbs.org/json/?search=bones.s08&user=you&api=apikeyfoundinyraccount&catid=19,20&retention=500
this would search for bones.s08 in tvsd,tvhd with a max age of 500 days.

sample output:

[
{
nzbid: "100677",
release: "Some.Movie.Title-GRP",
group: "alt.binaries.moovee",
sizebytes: "1601590891",
usenetage: "1317286337",
categoryid: "15",
cattext: "movies.sd",
language: "11",
weblink: "http://example.com/",
details: "https://omgwtfnzbs.org/details.php?id={nzbid}",
getnzb: "https://api.omgwtfnzbs.org/sn.php?id={nzbid}&user={username}&api={apikey}"
}
]
If your request was successful you will get upto 500 results listed in JSON format


other responses:

* {"notice":"no search no results"} = Search term is required
* {"notice":"0 results matched your terms"} = No results for your query were found
* {"notice":"search to short"} = min term must be 3 characters or more ([a-Z0-9]) any other characters will be ignored
* {"notice":"your user or api information is incorrect.. check and try again"} = Bad/Incorrect api auth details


XML Search API: (updated 9th March 2013)
url to use:
https://api.omgwtfnzbs.org/xml/?search={some search term}&user={username}&api={apikey}

variables:
* ?search=something = string to search for (also see special features)
* &username={username} = Your account username.
* &api={apikey} = Your API Key.
* &catid=1,2,3 ect = Optional, search multiple categorys.
* &eng=1 = Optional, return only english/unknown posts.
* &retention={days} = Optional, limit the search to X amount of days ago.
* &page={#} = go to the next page of results if there is any.

If your request was successful you will get upto 500 results per page listed in xml format

special features:
* ?search= Sending a request with a blank search term will return results from the last 7 days &retention= will have no effect on your query
* ?search=tt1234567 = Search using the IMDB id. (if included at time of index)

sample output:

<xml version="1.0" encoding="ISO-8859-1">

<info>
<results>100</results>
<pages>2</pages>
<current_page>1</current_page>
<published>server time request was published</published
</info>

<search_req>

<post>
<release>Some.FLAC.Release.Name-INFO</release>
<group>alt.binaries.sounds.flac</group>
<sizebytes>286396335</sizebytes>
<usenetage>1338679302</usenetage>
<categoryid>22</categoryid>
<cattext>music.flac</cattext>
<language>0</language>
<imglink>https://if-added.jpg</imglink>
<weblink>http://weblink.net</weblink>
<details>https://omgwtfnzbs.org/details.php?id={nzbid}</details>
<getnfo>https://api.omgwtfnzbs.org/nfo/?id={nzbid}&user={username}&api={apikey}/getnfo>
<getnzb>https://api.omgwtfnzbs.org/sn.php?id={nzbid}&user={username}&api={apikey}</getnzb>
</post>

</search_req>
</xml>
Notice:
All requests are cached for 10 minutes to reduce the load on the server.


other responses:

* {no search no xml} = Search term is required
* {invalid search terms} = Invalid search term
* {0 results found} = No results for your query were found
* {search to short} = min term must be 3 characters or more.
* {your user/api information is incorrect.. check and try again} = Bad/Incorrect api auth details


Direct Download API:
No HTML output is generated and the NZB is sent directly to your software/browser etc.

url to use:
https://api.omgwtfnzbs.org/sn.php?id={nzbid#}&user={username}&api={apikey}

variables:
* ?id={nzbid#} = taken from omgwtfnzbs.org
* &user={username} = Your account username.
* &api={apikey} = Your API Key.

output results:
If your request was successful the NZB will be sent directly to your browser/software.

If there was a problem with your request one the following responses will be output.

* {your user/api information is incorrect.. check and try again} = There is a problem with the username/apikey you have provided.
* {bad nzbid#} = Invalid nzbid#.

notes:
Only full posts can be retrieved, there is no support for partial posts.
Only one post can be downloaded per request.


GET NFO API:
url to use:
https://api.omgwtfnzbs.org/nfo/?id={NZBID}&user={username}&api={apikey}

variables:
* ?id={nzbid#} = taken from omgwtfnzbs.org
* &user={username} = Your account username.
* &api={apikey} = Your API Key.

output results:
If your request was successful the NFO will be displayed in your browser/software.

If there was a problem with your request one the following responses will be output.

* {your user/api information is incorrect.. check and try again} = There is a problem with the username/apikey you have provided.
* {bad nzbid#} = Invalid nzbid#.
* {nfo unavailable} = No NFO file has been linked to nzbid#.

notes:
Only one NFO can be viewed per request.

----------------------------------API DOC----------------------------------