Skip to content
Get started

Get Instrument Analyst Consensus

InstrumentDataGetInstrumentAnalystConsensusResponse v1().instrumentData().getInstrumentAnalystConsensus(InstrumentDataGetInstrumentAnalystConsensusParamsparams = InstrumentDataGetInstrumentAnalystConsensusParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/instruments/{instrument_id}/analyst-reporting

Retrieves analyst ratings and price targets for an instrument.

ParametersExpand Collapse
InstrumentDataGetInstrumentAnalystConsensusParams params
Optional<String> instrumentId

OEMS instrument UUID

formatuuid
Optional<LocalDate> from

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

formatdate
Optional<LocalDate> to

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

formatdate
ReturnsExpand Collapse
class InstrumentDataGetInstrumentAnalystConsensusResponse:

Aggregated analyst consensus metrics

LocalDate date

The date the consensus snapshot was generated

formatdate
Optional<AnalystDistribution> distribution

Count of individual analyst recommendations by category

long buy

Number of buy recommendations

formatint64
long hold

Number of hold recommendations

formatint64
long sell

Number of sell recommendations

formatint64
long strongBuy

Number of strong buy recommendations

formatint64
long strongSell

Number of strong sell recommendations

formatint64
Optional<PriceTarget> priceTarget

Aggregated analyst price target statistics

String average

Average analyst price target

String currency

ISO 4217 currency code of the price targets

String high

Highest analyst price target

String low

Lowest analyst price target

Optional<AnalystRating> rating

Consensus analyst rating

One of the following:
STRONG_BUY("STRONG_BUY")
BUY("BUY")
HOLD("HOLD")
SELL("SELL")
STRONG_SELL("STRONG_SELL")

Get Instrument Analyst Consensus

package com.clear_street.api.example;

import com.clear_street.api.client.ClearStreetClient;
import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient;
import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentAnalystConsensusParams;
import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentAnalystConsensusResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        InstrumentDataGetInstrumentAnalystConsensusResponse response = client.v1().instrumentData().getInstrumentAnalystConsensus("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
    }
}
{
  "data": {
    "date": "2025-10-01",
    "distribution": {
      "buy": 20,
      "hold": 3,
      "sell": 1,
      "strong_buy": 18,
      "strong_sell": 0
    },
    "price_target": {
      "average": "240.00",
      "currency": "USD",
      "high": "275.00",
      "low": "190.00"
    },
    "rating": "BUY"
  },
  "error": null,
  "metadata": {
    "request_id": "9e0f1a2b-3c4d-5e6f-7890-1a2b3c4d5e6f"
  }
}
{
  "error": {
    "code": 404,
    "message": "Instrument not found: AAP"
  },
  "metadata": {
    "request_id": "fa8cc9b2-fbf0-4f5b-8ce3-b3205b9f85f2"
  }
}
Returns Examples
{
  "data": {
    "date": "2025-10-01",
    "distribution": {
      "buy": 20,
      "hold": 3,
      "sell": 1,
      "strong_buy": 18,
      "strong_sell": 0
    },
    "price_target": {
      "average": "240.00",
      "currency": "USD",
      "high": "275.00",
      "low": "190.00"
    },
    "rating": "BUY"
  },
  "error": null,
  "metadata": {
    "request_id": "9e0f1a2b-3c4d-5e6f-7890-1a2b3c4d5e6f"
  }
}
{
  "error": {
    "code": 404,
    "message": "Instrument not found: AAP"
  },
  "metadata": {
    "request_id": "fa8cc9b2-fbf0-4f5b-8ce3-b3205b9f85f2"
  }
}