SaveAlertRequestDTOv2

stonepy.models.SaveAlertRequestDTOv2.SaveAlertRequestDTOv2

Bases: RequestModel

Request to save a price alert on the specified market.

client_account_id class-attribute instance-attribute

client_account_id: int = Field(alias='ClientAccountId')

Client account identifier

alert_id class-attribute instance-attribute

alert_id: int = Field(alias='AlertId')

Price alert identifier

market_id class-attribute instance-attribute

market_id: int = Field(alias='MarketId')

Identifier of the market upon which the price alert is placed

criterion class-attribute instance-attribute

criterion: AlertCriterion = Field(alias='Criterion')

The condition to trigger the price alert

direction class-attribute instance-attribute

direction: AlertDirection = Field(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 = Field(alias='FillRate')

The market price at which the price alert will be triggered

email_address class-attribute instance-attribute

email_address: str = Field(alias='EmailAddress')

The user's email address

expiry class-attribute instance-attribute

expiry: AlertExpiry = Field(alias='Expiry')

The expiry type of the alert such as Good Till Cancelled (GTC) or Good Till Date (GTD)

expiry_date class-attribute instance-attribute

expiry_date: StoneXDateTime = Field(alias='ExpiryDate')

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

comment class-attribute instance-attribute

comment: str = Field(alias='Comment')

User comment for this price alert

notification_method class-attribute instance-attribute

notification_method: AlertNotification = Field(
    alias="NotificationMethod"
)

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