Skip to main content

GetStrategyMetricsArgs

Arguments for GetStrategyMetrics.

Inherits fields from HistoricalMetricQueryArgs.

FieldTypeRequiredNullableDefaultDescription
ResolutionHistoricalDataResolutionNoNoHistoricalDataResolution.AutoRequested representation. Defaults to bounded chart-history mode.
GranularityHistoricalRollupGranularityNoNoHistoricalRollupGranularity.DailyRollup granularity used when Resolution is HistoricalDataResolution.Rollup or HistoricalDataResolution.Auto. Ignored for HistoricalDataResolution.Raw.
StartUtcdatetimeNoYesInclusive UTC lower bound applied to each point's effective HistoricalDataPoint.TimestampUtc. Null lets the server choose the oldest allowed point.
EndUtcdatetimeNoYesExclusive UTC upper bound applied to each point's effective HistoricalDataPoint.TimestampUtc. For Raw, null enables tail-following. For Auto/Rollup, null is materialized by the server into a bounded effective end time and does not create a tail-following cursor.
LimitintNoYesMaximum number of points to return across all series in one page. The server caps this at MaxLimit; when null the server applies a default page size.
ContinuationTokenstrNoYesOpaque pagination token from a previous page of the same semantic query.
RollupValueModeHistoricalRollupValueModeNoNoHistoricalRollupValueMode.OhlcValue shape returned for rollup points. Raw points always carry close values only.
CompressionHistoricalDataCompressionNoNoHistoricalDataCompression.GzipCompression format requested for the returned payload bytes. Set HistoricalDataCompression.None to receive uncompressed JSON bytes.
IncludeHistoricalMetricIncludeNoNoHistoricalMetricInclude.AllMetric blocks to include in each returned point. Filters both close values and any requested OHLC values.
StrategyIdintYesNoLive strategy id to query.
UnderlyingContractIdintNoYesOptional underlying live contract id within the strategy. Null includes all underlyings the strategy traded.
LiveAccountIdslist[int]NoYesOptional internal live account ids to include. Null includes all accounts the strategy ran on.
BrokerAccountslist[HistoricalBrokerAccountSelector]NoYesOptional broker account selectors to include. Null includes all accounts the strategy ran on. If both LiveAccountIds and this property are supplied, the server treats the filter as a union.