API Documentation
The CreateDebate API allows people outside our organization to integrate our data into their applications. Use this data to create a website mash-up, a dashboard widget or a social network application! The API responds to requests in either XML or RSS, depending upon your preference. This documentation demonstrates how the data is returned and how to interact with our backend directly to get the data you need. If you have questions or comments, please contact us.
The base page for the Debate Search API is:
http://www.createdebate.com/browse/debaterss/
The Debate Search API defaults to the following URI:
http://www.createdebate.com/browse/debaterss/mostheated/all/alltypes/alltime/alltopics/0/12/open/all/rss
The Debate Search API is comprised of several parameters that can be modified to meet your needs:
http://www.createdebate.com/browse/debaterss/[sort]/[who]/[type]/[when]/[topic]/[offset]/[results]/[status]/[keyword]/[format]
Parameter | Allowed Values | Description |
[sort] |
mostheated mostrecent mostarguments mostvotes newactivity random relevance |
The sort parameter allows you to specify the algorithm that will be used to fetch and order the results. Please note that the relevance value may only be specified if a search keyword has been provided. |
[who] |
all [any valid username] |
The who parameter allows you to return only the debates created by a specific user. To disregard this parameter, use all. |
[type] |
alltypes koth twosided challenge newchallenge |
The type parameter allows you to return only certain kinds of debates. To disregard this parameter, use alltypes. |
[when] |
alltime thisweek thismonth thisyear today |
The when parameter allows you to specify a time period constraint based on the debate creation date. To disregard this parameter, use alltime. |
[topic] |
alltopics politics technology shopping travel science religion world sports business entertainment comedy |
The topic parameter allows you to specify a constraint based on the topic of the debate, as determined by the debate creator. To disregard this parameter, use alltopics. |
[offset] |
0 [any natural number] |
The offset parameter allows you to specify the first debate that should be returned from the result set. The default offset is 0. |
[results] |
12 24 48 96 |
The results parameter allows you to specify how many debates should be returned from the result set. The default number of results is 12. |
[status] |
open all closed |
The status parameter allows you to specify a constraint based on the debate end status. To disregard this parameter, use open. |
[keyword] |
all [any valid string] |
The keyword parameter allows you to specify a keyword that must be present in the debate title, debate description, side titles, or argument text. To disregard this parameter, use all. To be valid, the string can not contain special characters. |
[format] |
rss xml |
The format parameter allows you to specify the format in which the final result set will be returned. The default format is rss. |
debates.debate*.title - Contains the debate title.
debates.debate*.link - Contains the debate URL.
debates.debate*.description - Contains the debate description.
debates.debate*.topic - Contains the debate topic.
debates.debate*.pubDate - Contains the debate creation date.
debates.debate*.guid - Contains a globally unique identifier (same as the debate URL).
debates.debate*.externalLink.url - Contains a URL, if the debate references another website.
debates.debate*.externalLink.title - Contains a URL title, if the debate references another website.
debates.debate*.image.url - Contains the debate creator's profile picture URL.
debates.debate*.image.title - Contains the debate creator's username.
debates.debate*.image.link - Contains the debate creator's profile URL
debates.debate*.sides.side*.title - Contains the title for each side of the debate.
debates.debate*.sides.side*.pointsVal - Contains the score for each side of the debate.
debates.debate*.sides.side*.arguments - Contains the number of arguments for each side of the debate.