Skip to main content

SignalR Reference: Risk Graph Hub

Risk Graph Hub: position, strategy, underlying, and ad hoc combo Risk Graph snapshots and streams.

  • Hub URL: /hubs/riskgraph/v1

Snapshot methods return an API envelope (MesoLiveApiResponse<T>). Stream methods yield items until cancelled or disconnected.

Envelope fields: MesoLiveApiResponse

note

Risk Graph entries carry a compressed RiskGraphPayload. Decode Payload.Bytes according to Payload.Compression before reading RiskGraphData.

StreamPositionRiskGraphData

Stream Risk Graph updates for a position.

Args model: StreamPositionRiskGraphDataArgs

FieldTypeRequiredNullableDefaultDescription
PositionIdintYesNoLive position id to stream.
OptionsRiskGraphQueryOptionsNoNonew()Risk Graph query options.
StreamOptionsRiskGraphStreamOptionsNoNonew()Risk Graph stream timing options.

Yields (stream): PositionRiskGraphDataEntry

FieldTypeRequiredNullableDefaultDescription
PayloadRiskGraphPayloadYesNoCompressed Risk Graph payload envelope.
Diagnosticslist[RiskGraphDiagnostic]NoNo[]Diagnostics exposed outside the compressed payload for clients that need status before decoding.

GetPositionRiskGraphSnapshot

Get a point-in-time Risk Graph snapshot for a position.

Args model: GetPositionRiskGraphSnapshotArgs

FieldTypeRequiredNullableDefaultDescription
PositionIdintYesNoLive position id to snapshot.
OptionsRiskGraphQueryOptionsNoNonew()Risk Graph query options.

Returns (payload): GetPositionRiskGraphSnapshotResult

FieldTypeRequiredNullableDefaultDescription
PayloadRiskGraphPayloadYesNoCompressed Risk Graph payload envelope.
Diagnosticslist[RiskGraphDiagnostic]NoNo[]Diagnostics exposed outside the compressed payload for clients that need status before decoding.

StreamStrategyRiskGraphData

Stream Risk Graph updates for strategy exposure on one underlying.

Args model: StreamStrategyRiskGraphDataArgs

FieldTypeRequiredNullableDefaultDescription
StrategyIdintYesNoLive strategy id to stream.
UnderlyingIdintYesNoUnderlying live contract id within the strategy.
BrokerAccountIdslist[str]NoYesOptional broker account ids to include.
OptionsRiskGraphQueryOptionsNoNonew()Risk Graph query options.
StreamOptionsRiskGraphStreamOptionsNoNonew()Risk Graph stream timing options.

Yields (stream): StrategyRiskGraphDataEntry

FieldTypeRequiredNullableDefaultDescription
PayloadRiskGraphPayloadYesNoCompressed Risk Graph payload envelope.
Diagnosticslist[RiskGraphDiagnostic]NoNo[]Diagnostics exposed outside the compressed payload for clients that need status before decoding.

GetStrategyRiskGraphSnapshot

Get a point-in-time Risk Graph snapshot for strategy exposure on one underlying.

Args model: GetStrategyRiskGraphSnapshotArgs

FieldTypeRequiredNullableDefaultDescription
StrategyIdintYesNoLive strategy id to snapshot.
UnderlyingIdintYesNoUnderlying live contract id within the strategy.
BrokerAccountIdslist[str]NoYesOptional broker account ids to include.
OptionsRiskGraphQueryOptionsNoNonew()Risk Graph query options.

Returns (payload): GetStrategyRiskGraphSnapshotResult

FieldTypeRequiredNullableDefaultDescription
PayloadRiskGraphPayloadYesNoCompressed Risk Graph payload envelope.
Diagnosticslist[RiskGraphDiagnostic]NoNo[]Diagnostics exposed outside the compressed payload for clients that need status before decoding.

StreamUnderlyingRiskGraphData

Stream Risk Graph updates for default-position exposure on one underlying.

Args model: StreamUnderlyingRiskGraphDataArgs

FieldTypeRequiredNullableDefaultDescription
UnderlyingIdintYesNoUnderlying live contract id to stream.
BrokerAccountIdslist[str]NoYesOptional broker account ids to include.
OptionsRiskGraphQueryOptionsNoNonew()Risk Graph query options.
StreamOptionsRiskGraphStreamOptionsNoNonew()Risk Graph stream timing options.

Yields (stream): UnderlyingRiskGraphDataEntry

FieldTypeRequiredNullableDefaultDescription
PayloadRiskGraphPayloadYesNoCompressed Risk Graph payload envelope.
Diagnosticslist[RiskGraphDiagnostic]NoNo[]Diagnostics exposed outside the compressed payload for clients that need status before decoding.

GetUnderlyingRiskGraphSnapshot

Get a point-in-time Risk Graph snapshot for default-position exposure on one underlying.

Args model: GetUnderlyingRiskGraphSnapshotArgs

FieldTypeRequiredNullableDefaultDescription
UnderlyingIdintYesNoUnderlying live contract id to snapshot.
BrokerAccountIdslist[str]NoYesOptional broker account ids to include.
OptionsRiskGraphQueryOptionsNoNonew()Risk Graph query options.

Returns (payload): GetUnderlyingRiskGraphSnapshotResult

FieldTypeRequiredNullableDefaultDescription
PayloadRiskGraphPayloadYesNoCompressed Risk Graph payload envelope.
Diagnosticslist[RiskGraphDiagnostic]NoNo[]Diagnostics exposed outside the compressed payload for clients that need status before decoding.

StreamComboContractsRiskGraphData

Stream Risk Graph updates for caller-specified combo contracts.

Args model: StreamComboContractsRiskGraphDataArgs

FieldTypeRequiredNullableDefaultDescription
ComboLegsdict[str, ComboContractsRiskGraphLegSpec]YesNoCombo legs keyed by caller-provided leg name.
RealizedPnlOffsetDecimalNoNo0mRealized PnL offset included in aggregate PnL.
OptionsRiskGraphQueryOptionsNoNonew()Risk Graph query options.
StreamOptionsRiskGraphStreamOptionsNoNonew()Risk Graph stream timing options.

Yields (stream): ComboContractsRiskGraphDataEntry

FieldTypeRequiredNullableDefaultDescription
PayloadRiskGraphPayloadYesNoCompressed Risk Graph payload envelope.
Diagnosticslist[RiskGraphDiagnostic]NoNo[]Diagnostics exposed outside the compressed payload for clients that need status before decoding.

GetComboContractsRiskGraphSnapshot

Get a point-in-time Risk Graph snapshot for caller-specified combo contracts.

Args model: GetComboContractsRiskGraphSnapshotArgs

FieldTypeRequiredNullableDefaultDescription
ComboLegsdict[str, ComboContractsRiskGraphLegSpec]YesNoCombo legs keyed by caller-provided leg name.
RealizedPnlOffsetDecimalNoNo0mRealized PnL offset included in aggregate PnL.
OptionsRiskGraphQueryOptionsNoNonew()Risk Graph query options.

Returns (payload): GetComboContractsRiskGraphSnapshotResult

FieldTypeRequiredNullableDefaultDescription
PayloadRiskGraphPayloadYesNoCompressed Risk Graph payload envelope.
Diagnosticslist[RiskGraphDiagnostic]NoNo[]Diagnostics exposed outside the compressed payload for clients that need status before decoding.