GET
/
consensus-ratings

Authorizations

token
string
queryrequired

Headers

accept
enum<string>
default: application/jsonrequired

Specifies return format. Query parameters work the same for both formats.

Available options:
application/json

Query Parameters

pagesize
integer

Number of results returned. Limit 1000

parameters[date_from]
string

Date to query from point in time.

parameters[date_to]
string

Date to query to point in time.

parameters[tickers]
string

One ticker symbol to query the aggregate for. All calendars accept this parameter (not including the FDA endpoint; for the FDA endpoint, please use "parameters[securities]" instead). Ignored by the Economics endpoint. Maximum 1 ticker.

simplify
boolean
default: false

To simplify the aggregate ratings to only BUY, SELL, HOLD, default will return all ratings (STRONG_BUY, BUY, HOLD, SELL, STRONG_SELL).

aggregate_type
enum<string>
default: number

To aggregate the ratings by either number or percentage.

Available options:
number,
percentage

Response

200 - application/json
ratings
object[]