POST
/
v1
/
analyst-estimates
/
query
Query Analyst Estimates
curl --request POST \
  --url https://api.bigdata.com/v1/analyst-estimates/query \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "identifier": {
    "type": "rp_entity_id",
    "value": "4A6F00"
  },
  "period": "annual",
  "limit": 123
}'
{
  "results": {
    "rp_entity_id": "4A6F00",
    "target_identifier_id": "GOOGL",
    "fields": "FISCAL_PERIOD_END_DATE",
    "values": [
      "2025-12-31",
      387588929898,
      399321530206,
      394966067919,
      135473353787,
      139574231263,
      138051873327,
      115816555170,
      119322406979,
      118020938853,
      118458970299,
      126884966950,
      121111982610,
      55347517673,
      57022927502,
      56400969528,
      9.94514,
      10.19402,
      9.51707,
      42,
      47
    ]
  },
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "pagination": {
    "cursor": "00000DexaRK4NT6t",
    "has_cursor": true
  },
  "metadata": {
    "request_id": "<string>",
    "timestamp": "<string>"
  }
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
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>

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

Available options:
annual,
quarter
limit
integer | null

Maximum number of events to return. If omitted, all events are returned.

Response

200 - application/json

Successful Response

results
object
required
errors
ErrorDetail · object[] | null
pagination
object | null

Common pagination response for endpoints that support pagination.

metadata
object | null