PriceAlertDTO

stonepy.models.PriceAlertDTO.PriceAlertDTO

Bases: ResponseModel

Information regarding a specific Price Alert.

client_account_id class-attribute instance-attribute

client_account_id: int | None = Field(
    default=None, alias="ClientAccountId"
)

Client account ID.

market_name class-attribute instance-attribute

market_name: str | None = Field(
    default=None, alias="MarketName"
)

The name of the market.

triggered_price class-attribute instance-attribute

triggered_price: Decimal | None = Field(
    default=None, alias="TriggeredPrice"
)

The price that caused the Price Alert to Trigger.

triggered_date class-attribute instance-attribute

triggered_date: StoneXDateTime | None = Field(
    default=None, alias="TriggeredDate"
)

The date of the triggered price alert. Always expressed in UTC.

alert_state class-attribute instance-attribute

alert_state: int | None = Field(
    default=None, alias="AlertState"
)

The state of the alert. Can be one of the following: Added = 0, Updated = 1, Deleted = 2, Triggered = 3

alert_id class-attribute instance-attribute

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

The Price Alert identifier.

market_id class-attribute instance-attribute

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

The Market identifier.

criterion class-attribute instance-attribute

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

The criterion to use when checking the price. Can be one of the following: AtOrAbove = 1, AtOrBelow = 2

direction class-attribute instance-attribute

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

Direction of the price Alert. Can be one of the following: Buy = 1, Sell = 2

fill_rate class-attribute instance-attribute

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

The Price the Alert was created with.

email_address class-attribute instance-attribute

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

The email address for the recipient of the Price Alert.

expiry class-attribute instance-attribute

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

Specifies the type of the expiry. The options are: Good To Cancelled = 1, Good to Date = 2

expiry_date class-attribute instance-attribute

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

The date of expiry.

create_date class-attribute instance-attribute

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

The date the Price Alert was created.

comment class-attribute instance-attribute

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

This is the user created custom message added to the alert when created.

notification_method class-attribute instance-attribute

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

The notification Method. Can be one of the following: None = 0, Email = 1, Sms = 2, EmailAndSms = 3, PushNotification = 4, EmailAndPushNotification = 5, SmsAndPushNotification = 6, EmailAndSmsAndPushNotification = 7