[edit] API Docs

[edit] What is a REST API?

Simply put, a REST API is code that responds to formatted requests.

[edit] Response Types

We offer JSON and XML output for our REST APIs. Our default is JSON.

[edit] Request Methods

All of the rest API's can accept either GET or POST requests, requests using either method are treated exactly the same. The typical usage is to use POST when sending large amounts of data (creating a new forum post, for example) and GET when just sending a few filtering parameters in order to get some data back.

[edit] Errors

Whenever one of the REST API's runs into a unknown problem, it will send back an error message like so:

• XML Response:

 <response>
   <success>0</success>
   <message>This is the text of the error message</message>
 </response>

• JSON Response:

 {"success":0,"message":"This is the text of the error message"}

If you're getting an error message in one of the above formats, please check that the data you're sending to the API is valid. If the data looks good and you're still having problems, please contact support.