ApiSimulateTradeOrderResponseDTO

stonepy.models.ApiSimulateTradeOrderResponseDTO.ApiSimulateTradeOrderResponseDTO

Bases: ResponseModel

The response from a simulated trade request sent by the SimulateTrade service.

status class-attribute instance-attribute

status: int | None = Field(default=None, alias='Status')

The status of the simulated order (Pending, Accepted, Open, etc.) . The table of lookup codes can be found at Lookup Values .

status_reason class-attribute instance-attribute

status_reason: int | None = Field(
    default=None, alias="StatusReason"
)

The ID corresponding to a more descriptive reason for the order status. The table of lookup codes can be found at Lookup Values .

simulated_cash class-attribute instance-attribute

simulated_cash: Decimal | None = Field(
    default=None, alias="SimulatedCash"
)

The simulated cash balance after executing (opening or closing) a trade. The balance may decrease after opening a trade (as cash may be allocated towards margin requirement) and increase /reduce /remain unchanged following a closure.

actual_cash class-attribute instance-attribute

actual_cash: Decimal | None = Field(
    default=None, alias="ActualCash"
)

The actual cash balance before the trade.

simulated_total_margin_requirement class-attribute instance-attribute

simulated_total_margin_requirement: Decimal | None = Field(
    default=None, alias="SimulatedTotalMarginRequirement"
)

The simulated total margin requirement (TMR) after executing (opening or closing) a trade.

actual_total_margin_requirement class-attribute instance-attribute

actual_total_margin_requirement: Decimal | None = Field(
    default=None, alias="ActualTotalMarginRequirement"
)

The actual total margin requirement (TMR) before the trade.

currency_id class-attribute instance-attribute

currency_id: int | None = Field(
    default=None, alias="CurrencyId"
)

The currency ID for the currency values in this response.

orders class-attribute instance-attribute

orders: list[ApiSimulateOrderResponseDTO] | None = Field(
    default=None, alias="Orders"
)

List of simulated orders with their associated response.

adjust class-attribute instance-attribute

adjust: Decimal | None = Field(default=None, alias="Adjust")

The amount of additional spread charged to reflect trade size and underlying liquidity.