Skip to main content
POST
Analyst Estimates

Authorizations

X-API-KEY
string
header
required

Body

application/json
identifier
Identifier · object
required

Object specifying which identifier you are using to request the analyst estimates. You must supply one type and its corresponding value.

period
enum<string>
default:quarter

Select whether the estimates to be provided are on an annual or quarterly basis.

Available options:
annual,
quarter
Example:

"annual"

limit
integer | null
default:20

Maximum number of analyst estimates to return, starting from the furthest-future forecasted period available and working backwards. If omitted, defaults to 20. Values above 200 are rejected.

Example:

20

Response

200 - application/json

Successful Response

results
AnalystEstimates · object
required
errors
ErrorDetail · object[] | null
metadata
Metadata · object | null
sources
Source · object[]

The content catalog sources the response was built from, one entry per source. Empty when no catalog source contributed.

usage
Usage · object | null

Tokens the request consumed, per content tier. Present only for API keys billed in tokens.