MarketSearchResultDTO

stonepy.models.MarketSearchResultDTO.MarketSearchResultDTO

Bases: ResponseModel

Market information response to a SearchWithoutTags request.

market_id class-attribute instance-attribute

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

The ID of the market.

name class-attribute instance-attribute

name: str | None = Field(default=None, alias='Name')

The market name.

exchange_id class-attribute instance-attribute

exchange_id: int | None = Field(
    default=None, alias="ExchangeId"
)

Unique identifier for the exchange where the underlying is traded.

exchange_name class-attribute instance-attribute

exchange_name: str | None = Field(
    default=None, alias="ExchangeName"
)

The name of the exchange where the underlying is traded.

margin_factor class-attribute instance-attribute

margin_factor: Decimal | None = Field(
    default=None, alias="MarginFactor"
)

Margin factor, expressed as points or as a percentage.

min_margin_factor class-attribute instance-attribute

min_margin_factor: Decimal | None = Field(
    default=None, alias="MinMarginFactor"
)

The minimum margin factor.

margin_factor_units class-attribute instance-attribute

margin_factor_units: int | None = Field(
    default=None, alias="MarginFactorUnits"
)

Controls if the margin factor is displayed as a percentage or in points. (Percentage=26, and Points=27) .

max_margin_factor class-attribute instance-attribute

max_margin_factor: Decimal | None = Field(
    default=None, alias="MaxMarginFactor"
)

The maximum margin factor.

client_margin_factor class-attribute instance-attribute

client_margin_factor: Decimal | None = Field(
    default=None, alias="ClientMarginFactor"
)

The client specific margin factor (global leverage) .

market_type class-attribute instance-attribute

market_type: str | None = Field(
    default=None, alias="MarketType"
)

Description of the market type. This can be 'Option Market', 'Ordinary Market', or 'Binary Market'.

market_type_id class-attribute instance-attribute

market_type_id: int | None = Field(
    default=None, alias="MarketTypeId"
)

Identifier for each of the market types. (Option=1, Ordinary=2 and Binary=4) .

min_distance class-attribute instance-attribute

min_distance: Decimal | None = Field(
    default=None, alias="MinDistance"
)

The minimum distance from the current price you can place an order.

min_distance_units class-attribute instance-attribute

min_distance_units: int | None = Field(
    default=None, alias="MinDistanceUnits"
)

The minimum distance unit type. This can be: (Percentage=26, Points=27) .

option_type class-attribute instance-attribute

option_type: str | None = Field(
    default=None, alias="OptionType"
)

Indicates if the option is a Call or a Put option.

option_type_id class-attribute instance-attribute

option_type_id: int | None = Field(
    default=None, alias="OptionTypeId"
)

ID number indicating the option type: Put=1 and Call=2 . This value is null for non-option markets.

strike_price class-attribute instance-attribute

strike_price: Decimal | None = Field(
    default=None, alias="StrikePrice"
)

The strike price of the option. This value is null for non-option markets.

web_min_size class-attribute instance-attribute

web_min_size: Decimal | None = Field(
    default=None, alias="WebMinSize"
)

The minimum quantity that can be traded over the web.

max_size class-attribute instance-attribute

max_size: Decimal | None = Field(
    default=None, alias="MaxSize"
)

The max size of an order.

market_sizes_currency_code class-attribute instance-attribute

market_sizes_currency_code: str | None = Field(
    default=None, alias="MarketSizesCurrencyCode"
)

The currency code for the currency used in the MaxLongSize and MaxShortSize fields.

market24_h class-attribute instance-attribute

market24_h: bool | None = Field(
    default=None, alias="Market24H"
)

Flag indicating whether the market is a 24 hour market.

price_decimal_places class-attribute instance-attribute

price_decimal_places: int | None = Field(
    default=None, alias="PriceDecimalPlaces"
)

The number of decimal places in the market's price.

default_quote_length class-attribute instance-attribute

default_quote_length: int | None = Field(
    default=None, alias="DefaultQuoteLength"
)

Default quote length.

trade_on_web class-attribute instance-attribute

trade_on_web: bool | None = Field(
    default=None, alias="TradeOnWeb"
)

Flag indicating whether you can trade this market on the web.

limit_up class-attribute instance-attribute

limit_up: bool | None = Field(default=None, alias="LimitUp")

New sell orders will be rejected. Orders resulting in a short open position will be red carded.

limit_down class-attribute instance-attribute

limit_down: bool | None = Field(
    default=None, alias="LimitDown"
)

New buy orders will be rejected. Orders resulting in a long open position will be red carded.

long_position_only class-attribute instance-attribute

long_position_only: bool | None = Field(
    default=None, alias="LongPositionOnly"
)

Cannot open a short position. Equivalent to limit up.

close_only class-attribute instance-attribute

close_only: bool | None = Field(
    default=None, alias="CloseOnly"
)

Can only close open positions. Equivalent to both Limit up and Limit down.

market_eod class-attribute instance-attribute

market_eod: list[ApiMarketEodDTO] | None = Field(
    default=None, alias="MarketEod"
)

List of market end of day DTOs.

price_tolerance class-attribute instance-attribute

price_tolerance: Decimal | None = Field(
    default=None, alias="PriceTolerance"
)

Setting to indicate the user's price tolerance for the given market.

convert_price_to_pips_multiplier class-attribute instance-attribute

convert_price_to_pips_multiplier: int | None = Field(
    default=None, alias="ConvertPriceToPipsMultiplier"
)

Multiplier used to calculate the significance of the price tolerance to the appropriate decimal place.

market_settings_type_id class-attribute instance-attribute

market_settings_type_id: int | None = Field(
    default=None, alias="MarketSettingsTypeId"
)

The ID type of the market setting. (Spread=1, CFD=2, Binary=3, FX=4, Cash=5, All=6) .

market_settings_type class-attribute instance-attribute

market_settings_type: str | None = Field(
    default=None, alias="MarketSettingsType"
)

The type of the market setting, i.e. Spread, CFD.

mobile_short_name class-attribute instance-attribute

mobile_short_name: str | None = Field(
    default=None, alias="MobileShortName"
)

A short summary of the market name used when presenting the market name on mobile clients.

central_clearing_type class-attribute instance-attribute

central_clearing_type: str | None = Field(
    default=None, alias="CentralClearingType"
)

The method used for central clearing, i.e. "No" or "LCH".

central_clearing_type_description class-attribute instance-attribute

central_clearing_type_description: str | None = Field(
    default=None, alias="CentralClearingTypeDescription"
)

The description of the method used for central clearing, i.e. "None" or "London Clearing House".

market_currency_id class-attribute instance-attribute

market_currency_id: int | None = Field(
    default=None, alias="MarketCurrencyId"
)

The currency of the market being traded.

phone_min_size class-attribute instance-attribute

phone_min_size: Decimal | None = Field(
    default=None, alias="PhoneMinSize"
)

The minimum quantity that can be traded over the Phone.

daily_financing_applied_at_utc class-attribute instance-attribute

daily_financing_applied_at_utc: StoneXDateTime | None = (
    Field(default=None, alias="DailyFinancingAppliedAtUtc")
)

Daily financing amount to be applied at specified time in UTC.

next_market_eod_time_utc class-attribute instance-attribute

next_market_eod_time_utc: StoneXDateTime | None = Field(
    default=None, alias="NextMarketEodTimeUtc"
)

Next Date and Time at which the End of Day (EOD) capture will run in UTC.

trading_start_time_utc class-attribute instance-attribute

trading_start_time_utc: StoneXDateTime | None = Field(
    default=None, alias="TradingStartTimeUtc"
)

Market Trading start time on each trading day represented in UTC and local time.

trading_end_time_utc class-attribute instance-attribute

trading_end_time_utc: StoneXDateTime | None = Field(
    default=None, alias="TradingEndTimeUtc"
)

Market Trading end time on each trading day represented in UTC and local time.

market_pricing_times class-attribute instance-attribute

market_pricing_times: list[ApiTradingDayTimesDTO] | None = (
    Field(default=None, alias="MarketPricingTimes")
)

Market Pricing times on given set of working days.

market_break_times class-attribute instance-attribute

market_break_times: list[ApiTradingDayTimesDTO] | None = (
    Field(default=None, alias="MarketBreakTimes")
)

Breaks throughout each trading day (Day is specified as 'DayOfWeek') .

market_spreads class-attribute instance-attribute

market_spreads: list[ApiMarketSpreadDTO] | None = Field(
    default=None, alias="MarketSpreads"
)

Market spreads during each trading day.

guaranteed_order_premium class-attribute instance-attribute

guaranteed_order_premium: Decimal | None = Field(
    default=None, alias="GuaranteedOrderPremium"
)

The premium paid for a guaranteed order.

guaranteed_order_premium_units class-attribute instance-attribute

guaranteed_order_premium_units: int | None = Field(
    default=None, alias="GuaranteedOrderPremiumUnits"
)

The unit type being used for the guaranteed order premium. This can be (MultipleOfQuantity=1, PercentOfConsideration=2) .

guaranteed_order_min_distance class-attribute instance-attribute

guaranteed_order_min_distance: Decimal | None = Field(
    default=None, alias="GuaranteedOrderMinDistance"
)

The minimum distance from current market price at which a guaranteed order can be placed.

guaranteed_order_min_distance_units class-attribute instance-attribute

guaranteed_order_min_distance_units: int | None = Field(
    default=None, alias="GuaranteedOrderMinDistanceUnits"
)

Guaranteed order minimum distance unit type. This can be: (Percentage=26, Points=27) .

price_tolerance_units class-attribute instance-attribute

price_tolerance_units: Decimal | None = Field(
    default=None, alias="PriceToleranceUnits"
)

Price tolerance units - used with Price Tolerance as a multiplier (i.e. BetPer or Override Bet Per) .

market_time_zone_offset_minutes class-attribute instance-attribute

market_time_zone_offset_minutes: int | None = Field(
    default=None, alias="MarketTimeZoneOffsetMinutes"
)

Offset minutes to convert UTC times to local times.

quantity_conversion_factor class-attribute instance-attribute

quantity_conversion_factor: Decimal | None = Field(
    default=None, alias="QuantityConversionFactor"
)

The number of units for an instrument per actual traded units.

point_factor_divisor class-attribute instance-attribute

point_factor_divisor: int | None = Field(
    default=None, alias="PointFactorDivisor"
)

The number of cents which make up a dollar trade on the exchange.

bet_per class-attribute instance-attribute

bet_per: Decimal | None = Field(
    default=None, alias="BetPer"
)

Bet Per value for CFD and Spread Bet markets.

market_underlying_type_id class-attribute instance-attribute

market_underlying_type_id: int | None = Field(
    default=None, alias="MarketUnderlyingTypeId"
)

Reflects the market underlying type ID of the associated market. Equity=1 Index=2 Bond=3 FX=4 Commodity=5 Interest Rate=6 Metals=7 Equity - Common Stock=8 Equity - ADS=9 Binary=10 Sectors=11 FX Hedge=12

market_underlying_type class-attribute instance-attribute

market_underlying_type: str | None = Field(
    default=None, alias="MarketUnderlyingType"
)

Reflects the market underlying type description of the associated market.

allow_guaranteed_orders class-attribute instance-attribute

allow_guaranteed_orders: bool | None = Field(
    default=None, alias="AllowGuaranteedOrders"
)

Flag indicating whether guaranteed orders are allowed.

orders_aware_margining class-attribute instance-attribute

orders_aware_margining: bool | None = Field(
    default=None, alias="OrdersAwareMargining"
)

Flag to indicate if stop orders are allowed for inclusion in margin calculation.

orders_aware_margining_minimum class-attribute instance-attribute

orders_aware_margining_minimum: Decimal | None = Field(
    default=None, alias="OrdersAwareMarginingMinimum"
)

The minimum for orders aware margining.

commission_charge_minimum class-attribute instance-attribute

commission_charge_minimum: Decimal | None = Field(
    default=None, alias="CommissionChargeMinimum"
)

The minimum commission charged on trade/order.

commission_rate class-attribute instance-attribute

commission_rate: Decimal | None = Field(
    default=None, alias="CommissionRate"
)

The commission rate charged on trade/order.

commission_rate_units class-attribute instance-attribute

commission_rate_units: int | None = Field(
    default=None, alias="CommissionRateUnits"
)

The unit type for the commission rate charged on a trade/order. This can be: Minimum commission for equities - 11 Equities commission rate in basis points - 12 Commission for indices - 17 Equities commission rate in Cents Per Share - 23

expiry_utc class-attribute instance-attribute

expiry_utc: StoneXDateTime | None = Field(
    default=None, alias="ExpiryUtc"
)

Expiry of the market in UTC.

step_margin class-attribute instance-attribute

step_margin: ApiStepMarginDTO | None = Field(
    default=None, alias="StepMargin"
)

Step margin data for this market.

future_rollover_utc class-attribute instance-attribute

future_rollover_utc: StoneXDateTime | None = Field(
    default=None, alias="FutureRolloverUTC"
)

The date and time in UTC for the future rollover of the market.

allow_rollover class-attribute instance-attribute

allow_rollover: bool | None = Field(
    default=None, alias="AllowRollover"
)

Flag to indicate if auto-rollover on the market is allowed.

max_long_size class-attribute instance-attribute

max_long_size: Decimal | None = Field(
    default=None, alias="MaxLongSize"
)

Defines the maximum quantity accepted for buy direction trades or orders.

max_short_size class-attribute instance-attribute

max_short_size: Decimal | None = Field(
    default=None, alias="MaxShortSize"
)

Defines the maximum quantity accepted for sell direction trades or orders.

expiry_basis_id class-attribute instance-attribute

expiry_basis_id: int | None = Field(
    default=None, alias="ExpiryBasisId"
)

The expiry basis ID of the market.

expiry_basis_text class-attribute instance-attribute

expiry_basis_text: str | None = Field(
    default=None, alias="ExpiryBasisText"
)

The expiry basis text of the market.

weighting class-attribute instance-attribute

weighting: int | None = Field(
    default=None, alias="Weighting"
)

Weighting of the market between 0 and 1000 inclusive. Relays the priority of the market in the market search results. The higher the value the more prominent the market should appear.

underlying_ric_code class-attribute instance-attribute

underlying_ric_code: str | None = Field(
    default=None, alias="UnderlyingRicCode"
)

The Reuters Instrument Code (RIC) for the underlying market.

news_underlying_override_type class-attribute instance-attribute

news_underlying_override_type: str | None = Field(
    default=None, alias="NewsUnderlyingOverrideType"
)

The type of news override.

news_underlying_override_code class-attribute instance-attribute

news_underlying_override_code: str | None = Field(
    default=None, alias="NewsUnderlyingOverrideCode"
)

The value of the news override.