IntradayPricesQuery

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/bigdata/json-schema/bigdata-intraday-prices-query-schema.json",
  "title": "IntradayPricesQuery",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bigdata-market-data-api-openapi.yml#/components/schemas/IntradayPricesQuery",
  "properties": {
    "identifier": {
      "$ref": "#/$defs/SingleIdentifier",
      "description": "Object specifying which identifier you are using to request the intraday price. You must supply one type and its corresponding value. Only one identifier should be provided per request."
    },
    "timestamp": {
      "anyOf": [
        {
          "$ref": "#/$defs/QueryTimestamp"
        },
        {
          "type": "null"
        }
      ],
      "description": "The time range for retrieving intraday prices. All timestamps must be provided in the local time zone of the security exchange, and all results are returned in that same local exchange time. The expected timestamp format is 'YYYY-MM-DD', for example, '2025-09-02'."
    },
    "interval": {
      "$ref": "#/$defs/IntradayTimeFrame",
      "description": "The time interval for each intraday price data point. For example, '1min', '5min', '15min', '30min', '1hour', '4hour'."
    }
  },
  "type": "object",
  "required": [
    "identifier",
    "timestamp",
    "interval"
  ],
  "$defs": {
    "IdentifierTypeEnum": {
      "type": "string",
      "enum": [
        "rp_entity_id"
      ],
      "title": "IdentifierTypeEnum"
    },
    "IntradayTimeFrame": {
      "type": "string",
      "enum": [
        "1min",
        "5min",
        "15min",
        "30min",
        "1hour",
        "4hour"
      ],
      "title": "IntradayTimeFrame"
    },
    "QueryTimestamp": {
      "properties": {
        "start": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "Start",
          "description": "The start datetime of the time range for retrieving events. Only events occurring on or after this datetime will be included. The expected timestamp format is 'YYYY-MM-DD', for example, '2025-09-02'"
        },
        "end": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "End",
          "description": "The end datetime of the time range for retrieving events. Only events occurring on or before this datetime will be included. The expected timestamp format is 'YYYY-MM-DD', for example, '2025-09-03'."
        }
      },
      "type": "object",
      "title": "QueryTimestamp"
    },
    "SingleIdentifier": {
      "properties": {
        "type": {
          "$ref": "#/$defs/IdentifierTypeEnum",
          "description": "Object specifying which identifier you are using to request the data. You must supply one type and its corresponding value. Only one identifier should be provided per request."
        },
        "value": {
          "type": "string",
          "maxLength": 6,
          "minLength": 6,
          "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": "SingleIdentifier"
    }
  }
}