2buntu API

2buntu provides a public API for querying general information about articles. This API was originally developed to provide the 2buntu Android app with easy access to database content. We encourage all interested parties to use our API, but we do request that you let us know if you plan to be making a large volume of requests (more than 1,000 requests per day).

Technical Details

All responses received from the 2buntu API are in JSON format. Additionally, JSONP requests are supported by way of the callback=<whatever> parameter.

The absolute URL of each endpoint described below is constructed as follows:

/api/ API version / endpoint ? [parameters]

The current version of the API is 1.2.

Methods

Each of the endpoints is documented below and each of them returns a list of "article" objects.


/articles/

Returns a list of articles sorted by their publication date.

Parameter Description
min minimum publication timestamp for returned articles
max maximum publication timestamp for returned articles
page specifies the page of articles to obtain
size specifies the size of each page

/articles/{id}/

Returns information about a specific article. The {id} parameter refers to the ID of the article to be retrieved. This method will never return more than a single article.


/authors/

Returns a list of authors sorted by the number of articles published.

Parameter Description
min minimum last login timestamp for returned authors
max maximum last login timestamp for returned authors
page specifies the page of authors to obtain
size specifies the size of each page

/authors/{id}/

Returns information about a specific author. The {id} parameter refers to the ID of the author to be retrieved. This method will never return more than a single article.


/authors/{id}/articles/

Returns a list of articles written by the author identified by the {id} parameter.

Parameter Description
min minimum publication timestamp for returned articles
max maximum publication timestamp for returned articles
page specifies the page of articles to obtain
size specifies the size of each page

/categories/

Returns a list of categories sorted in alphabetical order.

Parameter Description
page specifies the page of categories to obtain
size specifies the size of each page

/categories/{id}/articles/

Returns a list of articles filed under the category identified by the {id} parameter.

Parameter Description
min minimum publication timestamp for returned articles
max maximum publication timestamp for returned articles
page specifies the page of articles to obtain
size specifies the size of each page