|
 |
NZBMatrix API Information |
 |
|
We are introducing an API (Application Programming Interface) for NZBMatrix.
To access the API you will need an API Key for your account. This can be found in "Your Account", and you must be a VIP member to use it.
The API is intended for use by application authors and developers that require an interface into NZBMatrix.
Any abuse may impose an API ban, or further restrictions. Not for Commercial use.
API KEY INFORMATION:
Generating your own unique API Key is very simple, simply visit "Your Account" and click [Generate New API Key]. A API Key will then be generated and displayed in the API area under Current API Key:
Your unique API Key is locked to your username, no one else will have access to it. If for some reason you think its been used elsewhere, stolen, lost or you just want it changed then simply generate a new key. Generating a new API Key will render the old one useless.
The API key is a 32 character string containing letters and numbers only. It is an algorithm of several aspects of your account details and random generated keys. It is impossible to replicate.
DIRECT DOWNLOAD API:
Put simple, using the Direct Download API will save you having to visit the site. No HTML output is generated and the NZB is sent directly to your software/browser etc.
Currently you can only request complete nzb posts, partial nzb postings are not supported.
Usage:
To use the Direct Download API please use the following syntax:
http://nzbmatrix.com/api-nzb-download.php?id={NZBID}&username={USERNAME}&apikey={APIKEY}
eg: http://nzbmatrix.com/api-nzb-download.php?id=123456&username=foobar&apikey=838d43ef5cb5346d83520f6886adf935
Breakdown:
- http://nzbmatrix.com/api-nzb-download.php? = URL to use. No other URL is supported, please do not try to use them.
- id={NZBID} = NZBid from NZBMatrix.com
- &username={USERNAME} = Your account username.
- &apikey={APIKEY} = Your API Key.
- &scenename=1 = Optional, this will restore scene names
Output Results:
If your request was successful the NZB you requested will be sent.
If there was a problem with your request the following will be output:
- error:invalid_login = There is a problem with the username you have provided.
- error:invalid_api = There is a problem with the API Key you have provided.
- error:invalid_nzbid = There is a problem with the NZBid supplied.
- error:please_wait_x = Please wait x seconds before retry.
- error:vip_only = You need to be VIP or higher to access.
- error:disabled_account = User Account Disabled.
- error:x_daily_limit = You have reached the daily download limit of x.
- error:no_nzb_found = No NZB found.
Notes:
All NZB posts downloaded with the API will count towards your daily download limits.
Only full posts can be retrieved, there is no support for partial posts.
You are limited to 6 NZBs per 60 seconds.
Only one post can be downloaded per request.
SSL is supported, please use https://nzbmatrix.com instead.
All output is sent using GZip Compression.
NZB POST DETAILS API:
This API will display various details of an NZB posting
Usage:
To use the NZB DETAILS API please use the following syntax:
http://nzbmatrix.com/api-nzb-details.php?id={NZBID}&username={USERNAME}&apikey={APIKEY}
eg: http://nzbmatrix.com/api-nzb-details.php?id=123456&username=foobar&apikey=838d43ef5cb5346d83520f6886adf935
Breakdown:
- http://nzbmatrix.com/api-nzb-details.php? = URL to use. No other URL is supported, please do not try to use them.
- id={NZBID} = NZBid from NZBMatrix.com
- &username={USERNAME} = Your account username.
- &apikey={APIKEY} = Your API Key.
Output Results:
Sample output is as follows, {FIELD}:{VALUE};
- NZBNAME:mandriva linux 2009; = NZB Name On Site
- INDEX_DATE:2009-02-14 09:08:55; = Indexed By Site (Date/Time GMT)
- USENET_DATE:2009-02-12 2:48:47; = Posted To Usenet (Date/Time GMT)
- GROUP:alt.binaries.linux; = Usenet Newsgroup
- PARTS:5702; = Number Of Parts
- SIZE:1469988208.64; = Size in bytes
- USENET_SUBJECT:[mandriva linux 2009] - "mandriva linux 2009.part03.rar" yEnc (1/201); = Usenet Post Subject
- COMMENTS:0; = Number Of Comments Posted
- HITS:174; = Number Of Hits (Views)
- NFO:yes; = NFO Present
- LINK:http://linux.org; = Web Link attached to NZB
If there was a problem with your request the following will be output:
- error:invalid_login = There is a problem with the username you have provided.
- error:invalid_api = There is a problem with the API Key you have provided.
- error:invalid_nzbid = There is a problem with the NZBid supplied.
- error:vip_only = You need to be VIP or higher to access.
- error:disabled_account = User Account Disabled.
- error:no_nzb_found = No NZB found.
Notes:
Only one post can be downloaded per request.
SSL is supported, please use https://nzbmatrix.com instead.
All output is sent using GZip Compression.
NZB SEARCH API:
This API will perform a NZB Post search and return a maximum of 5 results
Usage:
To use the NZB SEARCH API please use the following syntax:
http://nzbmatrix.com/api-nzb-search.php?search={SEARCH TERM}&catid={CATEGORYID}&num={MAX RESULTS}&username={USERNAME}&apikey={APIKEY}
eg: http://nzbmatrix.com/api-nzb-search.php?search=linux&catid=11&num=1&username=foobar&apikey=838d43ef5cb5346d83520f6886adf935
Breakdown:
- http://nzbmatrix.com/api-nzb-search.php? = URL to use. No other URL is supported, please do not try to use them.
- search={SEARCH TERM} = Search Term
- &catid={CATEGORYID} = OPTIONAL, if left blank all categories are searched, category ID used from site.
- &num={MAX RESULTS} = OPTIONAL, if left blank a maximum of 5 results will display, 5 is the maximum number of results that can be produced.
- &age={MAX AGE} = OPTIONAL, if left blank full site retention will be used. Age must be number of "days" eg 200
- ®ion={SEE DESC} = OPTIONAL, if left blank results will not be limited 1 = PAL, 2 = NTSC, 3 = FREE
- &group={SEE DESC} = OPTIONAL, if left blank all groups will be searched, format is full group name "alt.binaries.X"
- &username={USERNAME} = Your account username.
- &apikey={APIKEY} = Your API Key.
Output Results:
Sample output is as follows, {FIELD}:{VALUE};
- NZBID:444027; = NZB ID On Site
- NZBNAME:mandriva linux 2009; = NZB Name On Site
- LINK:nzbmatrix.com/nzb-details.php?id=444027&hit=1; = Link To NZB Details PAge
- SIZE:1469988208.64; = Size in bytes
- INDEX_DATE:2009-02-14 09:08:55; = Indexed By Site (Date/Time GMT)
- USENET_DATE:2009-02-12 2:48:47; = Posted To Usenet (Date/Time GMT)
- CATEGORY:TV > Divx/Xvid; = NZB Post Category
- GROUP:alt.binaries.linux; = Usenet Newsgroup
- COMMENTS:0; = Number Of Comments Posted
- HITS:174; = Number Of Hits (Views)
- NFO:yes; = NFO Present
- REGION:0; = Region Coding (See notes)
If there was a problem with your request the following will be output:
- error:invalid_login = There is a problem with the username you have provided.
- error:invalid_api = There is a problem with the API Key you have provided.
- error:invalid_nzbid = There is a problem with the NZBid supplied.
- error:vip_only = You need to be VIP or higher to access.
- error:disabled_account = User Account Disabled.
- error:no_nzb_found = No NZB found.
- error:no_search = No search query.
- error:nothing_found = No Results Found.
Notes:
A maximum of 5 results only.
&num=x OPTIONAL (Default 5).
&catid=x OPTIONAL (Default All).
Region Coding 0 = Unknown, 1 = PAL, 2 = NTSC, 3 = FREE
| Character will seperate search results
SSL is supported, please use https://nzbmatrix.com instead.
All output is sent using GZip Compression.
|
|
|
|
|
 Page Generated in 0.166371 seconds, with 0 Queries. (PHP 100.00%, MySQL 0.00%)
Privacy Policy | Terms | Toolbar | DMCA | API | NZBMatrix | Service Status
© 2005 - 2010 NZBxxx.com
  
NZBxxx.com does not host any files. NZBxxx.com indexes the contents of the public news service, Usenet.
Designated trademarks and brands are the property of their respective owners.
|
