CLclear-street
Instrument Data

Get Instrument Analyst Consensus

Changed on

Retrieves analyst ratings and price targets for an instrument.

get/v1/instruments/{instrument_id}/analyst-reporting

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Path parameters

instrument_idstring required

Instrument identifier: either an instrument UUID or a symbol (symbol for equities, OSI for options). Non-UUID inputs are resolved server-side.

Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).

Query parameters

fromstring date

The start date for the query range, inclusive (YYYY-MM-DD)

tostring date

The end date for the query range, inclusive (YYYY-MM-DD)

Response

Analyst consensus data

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  },
  "data": {
    "date": "2024-11-15",
    "distribution": {
      "buy": 28,
      "hold": 6,
      "sell": 2,
      "strong_buy": 20,
      "strong_sell": 0
    },
    "price_target": {
      "average": "220.00",
      "currency": "USD",
      "high": "250.00",
      "low": "180.00"
    },
    "rating": "STRONG_BUY"
  }
}

Changes

  • 1bd9eddeffc8Revision changes
    • breaking

      for the path request parameter instrument_id, the minLength was increased from 0 to 1

    • info

      for the path request parameter instrument_id, the type was generalized from no type to string