PublicAnalystEstimatesQuery

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/bigdata/json-schema/bigdata-public-analyst-estimates-query-schema.json",
  "title": "PublicAnalystEstimatesQuery",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bigdata-analyst-estimates-api-openapi.yml#/components/schemas/PublicAnalystEstimatesQuery",
  "properties": {
    "identifier": {
      "$ref": "#/$defs/Identifier",
      "description": "Object specifying which identifier you are using to request the analyst estimates. You must supply one type and its corresponding value."
    },
    "period": {
      "$ref": "#/$defs/AllowedPeriods",
      "description": "Select whether the estimates to be provided are on an annual or quarterly basis.",
      "default": "quarter"
    },
    "limit": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Limit",
      "description": "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.",
      "default": 20
    }
  },
  "type": "object",
  "required": [
    "identifier"
  ],
  "$defs": {
    "AllowedPeriods": {
      "type": "string",
      "enum": [
        "annual",
        "quarter"
      ],
      "title": "AllowedPeriods"
    },
    "Identifier": {
      "properties": {
        "type": {
          "$ref": "#/$defs/IdentifierType",
          "description": "The identifier namespace. Currently only `rp_entity_id` is supported.",
          "default": "rp_entity_id"
        },
        "value": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ],
          "title": "Value",
          "description": "Bigdata uses the RavenPack Entity identifier (RP_Entity_ID) to uniquely reference entities such as companies. This identifier is a 6-character alphanumeric code (letters and numbers only). Example: Alphabet Inc. (`4A6F00`)"
        }
      },
      "type": "object",
      "required": [
        "type",
        "value"
      ],
      "title": "Identifier"
    },
    "IdentifierType": {
      "type": "string",
      "enum": [
        "rp_entity_id"
      ],
      "title": "IdentifierType",
      "default": "rp_entity_id"
    }
  }
}