getRatings API

The getRatings API provides analysts ratings on stocks (strong buy, moderate buy, hold, moderate sell or strong sell) based on a symbol.

Pricing is based on the number of monthly queries and fields requested. We offer four packages: Small, Medium, Large, Enterprise. Contact us for additional details.


API Documentation

INPUTS:

symbols (required)
A symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used. For futures, notation such as <root_symbol*0> for the active contract or <root_symbol*1> for the first nearby is supported, as is <root_symbol^F> for all futures contracts for a given root symbol, as is <root_symbol^O> for all options contracts for a given underlying futures symbol. (list)
Example: AAPL,GOOG

fields (optional)
The fields requested. (list)
Example: strongBuy,hold,strongSell


OUTPUTS:

symbol (always returned)
A symbol or code that identifies a financial instrument. (string)
name (always returned)
The type of symbol used. (string)
averageRecommendation (always returned)
The average of all ratings (Strong Buy = 1.0, Moderate Buy = 2.0, Hold = 3.0, Moderate Sell = 4.0, Strong Sell = 5.0). (array)
strongBuy (as requested)
The number of Strong Buy ratings. (array)
moderateBuy (as requested)
The number of Moderate Buy ratings. (array)
hold (as requested)
The number of Hold ratings. (array)
moderateSell (as requested)
The number of Moderate Sell ratings. (array)
strongSell (as requested)
The number of Strong Sell ratings. (array)

STATUS CODE RESPONSES:

200 OK Success
400 Bad Request The request was invalid, please see the message for more information.
500 Internal Server Error Something is not working correctly, please contact support.