broker_facts

forge.testingfunctionSince Forge API 1
Signaturepython
forge.testing.broker_facts(*symbols: str,currency: str = 'USD',leverage: int = 100,server_tz_offset_minutes: int = 120,margin_mode: str = 'hedging',overrides: Mapping[str, Mapping[str, Any]] | None = None) -> dict[str, Any]

The oathra.broker_facts/1 payload a run receives, for the sample symbols.

Parameters

NameTypeDefault
*symbolsstr
currencystr'USD'
leverageint100
server_tz_offset_minutesint120
margin_modestr'hedging'
overridesMapping[str, Mapping[str, Any]] | NoneNone

overrides maps a symbol of the call to the fields to replace in its copied facts before the payload is hashed, so a test can set spread_points and still hold a payload with a valid content_hash.