GetStrategyMetricsArgs
Arguments for GetStrategyMetrics.
Inherits fields from HistoricalMetricQueryArgs.
| Field | Type | Required | Nullable | Default | Description |
|---|---|---|---|---|---|
Resolution | HistoricalDataResolution | No | No | HistoricalDataResolution.Auto | Requested representation. Defaults to bounded chart-history mode. |
Granularity | HistoricalRollupGranularity | No | No | HistoricalRollupGranularity.Daily | Rollup granularity used when Resolution is HistoricalDataResolution.Rollup or HistoricalDataResolution.Auto. Ignored for HistoricalDataResolution.Raw. |
StartUtc | datetime | No | Yes | Inclusive UTC lower bound applied to each point's effective HistoricalDataPoint.TimestampUtc. Null lets the server choose the oldest allowed point. | |
EndUtc | datetime | No | Yes | Exclusive 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. | |
Limit | int | No | Yes | Maximum 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. | |
ContinuationToken | str | No | Yes | Opaque pagination token from a previous page of the same semantic query. | |
RollupValueMode | HistoricalRollupValueMode | No | No | HistoricalRollupValueMode.Ohlc | Value shape returned for rollup points. Raw points always carry close values only. |
Compression | HistoricalDataCompression | No | No | HistoricalDataCompression.Gzip | Compression format requested for the returned payload bytes. Set HistoricalDataCompression.None to receive uncompressed JSON bytes. |
Include | HistoricalMetricInclude | No | No | HistoricalMetricInclude.All | Metric blocks to include in each returned point. Filters both close values and any requested OHLC values. |
StrategyId | int | Yes | No | Live strategy id to query. | |
UnderlyingContractId | int | No | Yes | Optional underlying live contract id within the strategy. Null includes all underlyings the strategy traded. | |
LiveAccountIds | list[int] | No | Yes | Optional internal live account ids to include. Null includes all accounts the strategy ran on. | |
BrokerAccounts | list[HistoricalBrokerAccountSelector] | No | Yes | Optional 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. |