AlertDTO

stonepy.models.AlertDTO.AlertDTO

Bases: ResponseModel

Represents the price alert entity.

alert_id class-attribute instance-attribute

alert_id: int | None = Field(default=None, alias='AlertId')

Price alert identifier.

market_id class-attribute instance-attribute

market_id: int | None = Field(
    default=None, alias="MarketId"
)

Identifier of the market upon which the price alert is placed.

criterion class-attribute instance-attribute

criterion: AlertCriterion | None = Field(
    default=None, alias="Criterion"
)

The condition to trigger the price alert.

direction class-attribute instance-attribute

direction: AlertDirection | None = Field(
    default=None, alias="Direction"
)

The market price type to use for the price alert - Buy price or Sell price.

fill_rate class-attribute instance-attribute

fill_rate: Decimal | None = Field(
    default=None, alias="FillRate"
)

The market price at which the price alert will be triggered.

email_address class-attribute instance-attribute

email_address: str | None = Field(
    default=None, alias="EmailAddress"
)

The user's email address.

expiry class-attribute instance-attribute

expiry: AlertExpiry | None = Field(
    default=None, alias="Expiry"
)

The expiry type of the alert.

expiry_date class-attribute instance-attribute

expiry_date: StoneXDateTime | None = Field(
    default=None, alias="ExpiryDate"
)

The price alert expiry date /time. Is Null in the case of GTC expiry.

create_date class-attribute instance-attribute

create_date: StoneXDateTime | None = Field(
    default=None, alias="CreateDate"
)

the date and time when the client placed the price alert.

comment class-attribute instance-attribute

comment: str | None = Field(default=None, alias='Comment')

User comment for this price alert.

notification_method class-attribute instance-attribute

notification_method: AlertNotification | None = Field(
    default=None, alias="NotificationMethod"
)

The communication method to notify the client when a price alert is triggered.