general information

The purpose of this API is to provide users information about coala Bears, the coala Contribution Statistics and to provide an interface to try coala online.

response

The API returns response in the JSON format.

/list/bears

Returns list of all the bears with their name, description and languages supported. The list is sorted alphabetically according to bear name.

Query

http://webservices.coala.io/list/bears

{ "AlexBear":
 {
 "desc": "Checks the markdown file with Alex - Catch insensitive, inconsiderate\nwriting.\n\nBe aware that Alex and this bear only work on English text.\nFor more information, consult .",
 "languages": ["Natural Language"]
 },

"AnnotationBear":
 {
 "desc": "Finds out all the positions of strings and comments in a file. The Bear searches for valid comments and strings and yields their ranges as SourceRange objects in HiddenResults.",
 "languages": []
 }
...
...
...
}

/contrib

Returns following details about contributors across all the coala repositories on GitHub:

• Name
• Commits
• Reviews
• Bio
• Issues Opened
• Teams

Query

http://webservices.coala.io/contrib

/editor

Non Optional Parameters

• file_data : Code on which analysis is to be done
• bears : List of bears to be used for analysis

Returns the result of coala analysis on the given code.

file_data: print( a + b )

bears : ['PEP8Bear']

http://webservices.coala.io/editor?file_data=file_data&bears=bearss