Motif API
    Preparing search index...

    Interface MarketsSvc

    interface MarketsSvc {
        dataMarkets: DataMarketList;
        defaultDefaultExchange: Exchange;
        defaultExchangeEnvironment: ExchangeEnvironment;
        defaultExchangeEnvironmentDataMarkets: DataMarketList;
        defaultExchangeEnvironmentExchanges: ExchangeList;
        defaultExchangeEnvironmentMarketBoards: MarketBoardList;
        defaultExchangeEnvironmentTradingMarkets: TradingMarketList;
        exchangeEnvironments: ExchangeEnvironmentList;
        exchanges: ExchangeList;
        genericUnknownDataMarket: DataMarket;
        genericUnknownExchange: Exchange;
        genericUnknownExchangeEnvironment: ExchangeEnvironment;
        genericUnknownMarketBoard: MarketBoard;
        genericUnknownTradingMarket: TradingMarket;
        marketBoards: MarketBoardList;
        tradingMarkets: TradingMarketList;
        unknownDataMarkets: DataMarketList;
        unknownExchangeEnvironments: ExchangeEnvironmentList;
        unknownExchanges: ExchangeList;
        unknownMarketBoards: MarketBoardList;
        unknownTradingMarkets: TradingMarketList;
        getDataMarketOrUnknown(zenithCode: string): DataMarket;
        getDataMarkets(
            zenithCodes: readonly string[],
            includeUnknown?: boolean,
        ): DataMarket[];
        getDefaultEnvironmentDataMarketOrUnknown(
            unenvironmentedZenithCode: string,
        ): DataMarket;
        getDefaultEnvironmentExchangeOrUnknown(
            unenvironmentedZenithCode: string,
        ): Exchange;
        getDefaultEnvironmentMarketBoardOrUnknown(
            unenvironmentedZenithCode: string,
        ): MarketBoard;
        getDefaultEnvironmentTradingMarketOrUnknown(
            unenvironmentedZenithCode: string,
        ): TradingMarket;
        getExchangeEnvironmentOrUnknown(zenithCode: string): ExchangeEnvironment;
        getExchangeOrUnknown(zenithCode: string): Exchange;
        getMarketBoardOrUnknown(
            zenithCode: string,
            market?: DataMarket,
        ): MarketBoard;
        getMarketBoards(
            zenithCodes: readonly string[],
            includeUnknown?: boolean,
            market?: DataMarket,
        ): MarketBoard[];
        getTradingMarketOrUnknown(zenithCode: string): TradingMarket;
        getTradingMarkets(
            zenithCodes: readonly string[],
            includeUnknown?: boolean,
        ): TradingMarket[];
        tryGetDataMarket(zenithCode: string, unknownAllowed?: boolean): DataMarket;
        tryGetDefaultEnvironmentDataMarket(
            unenvironmentedZenithCode: string,
            unknownAllowed?: boolean,
        ): DataMarket;
        tryGetDefaultEnvironmentExchange(
            unenvironmentedZenithCode: string,
            unknownAllowed?: boolean,
        ): Exchange;
        tryGetDefaultEnvironmentMarketBoard(
            unenvironmentedZenithCode: string,
            unknownAllowed?: boolean,
        ): MarketBoard;
        tryGetDefaultEnvironmentTradingMarket(
            unenvironmentedZenithCode: string,
            unknownAllowed?: boolean,
        ): TradingMarket;
        tryGetExchange(zenithCode: string, unknownAllowed?: boolean): Exchange;
        tryGetExchangeEnvironment(
            zenithCode: string,
            unknownAllowed?: boolean,
        ): ExchangeEnvironment;
        tryGetMarketBoard(
            zenithCode: string,
            unknownAllowed?: boolean,
            market?: DataMarket,
        ): MarketBoard;
        tryGetTradingMarket(
            zenithCode: string,
            unknownAllowed?: boolean,
        ): TradingMarket;
    }
    Index

    Properties

    dataMarkets defaultDefaultExchange defaultExchangeEnvironment defaultExchangeEnvironmentDataMarkets defaultExchangeEnvironmentExchanges defaultExchangeEnvironmentMarketBoards defaultExchangeEnvironmentTradingMarkets exchangeEnvironments exchanges genericUnknownDataMarket genericUnknownExchange genericUnknownExchangeEnvironment genericUnknownMarketBoard genericUnknownTradingMarket marketBoards tradingMarkets unknownDataMarkets unknownExchangeEnvironments unknownExchanges unknownMarketBoards unknownTradingMarkets

    Methods

    getDataMarketOrUnknown getDataMarkets getDefaultEnvironmentDataMarketOrUnknown getDefaultEnvironmentExchangeOrUnknown getDefaultEnvironmentMarketBoardOrUnknown getDefaultEnvironmentTradingMarketOrUnknown getExchangeEnvironmentOrUnknown getExchangeOrUnknown getMarketBoardOrUnknown getMarketBoards getTradingMarketOrUnknown getTradingMarkets tryGetDataMarket tryGetDefaultEnvironmentDataMarket tryGetDefaultEnvironmentExchange tryGetDefaultEnvironmentMarketBoard tryGetDefaultEnvironmentTradingMarket tryGetExchange tryGetExchangeEnvironment tryGetMarketBoard tryGetTradingMarket

    Properties

    dataMarkets: DataMarketList
    defaultDefaultExchange: Exchange
    defaultExchangeEnvironment: ExchangeEnvironment
    defaultExchangeEnvironmentDataMarkets: DataMarketList
    defaultExchangeEnvironmentExchanges: ExchangeList
    defaultExchangeEnvironmentMarketBoards: MarketBoardList
    defaultExchangeEnvironmentTradingMarkets: TradingMarketList
    exchangeEnvironments: ExchangeEnvironmentList
    exchanges: ExchangeList
    genericUnknownDataMarket: DataMarket
    genericUnknownExchange: Exchange
    genericUnknownExchangeEnvironment: ExchangeEnvironment
    genericUnknownMarketBoard: MarketBoard
    genericUnknownTradingMarket: TradingMarket
    marketBoards: MarketBoardList
    tradingMarkets: TradingMarketList
    unknownDataMarkets: DataMarketList
    unknownExchangeEnvironments: ExchangeEnvironmentList
    unknownExchanges: ExchangeList
    unknownMarketBoards: MarketBoardList
    unknownTradingMarkets: TradingMarketList

    Methods

    • Parameters

      • zenithCode: string

      Returns DataMarket

    • Parameters

      • zenithCodes: readonly string[]
      • OptionalincludeUnknown: boolean

      Returns DataMarket[]

    • Parameters

      • unenvironmentedZenithCode: string

      Returns DataMarket

    • Parameters

      • unenvironmentedZenithCode: string

      Returns Exchange

    • Parameters

      • unenvironmentedZenithCode: string

      Returns MarketBoard

    • Parameters

      • unenvironmentedZenithCode: string

      Returns TradingMarket

    • Parameters

      • zenithCode: string

      Returns Exchange

    • Only specify market if boards are all from that market

      Parameters

      • zenithCodes: readonly string[]
      • OptionalincludeUnknown: boolean
      • Optionalmarket: DataMarket

      Returns MarketBoard[]

    • Parameters

      • zenithCodes: readonly string[]
      • OptionalincludeUnknown: boolean

      Returns TradingMarket[]

    • Parameters

      • zenithCode: string
      • OptionalunknownAllowed: boolean

      Returns DataMarket

    • Parameters

      • unenvironmentedZenithCode: string
      • OptionalunknownAllowed: boolean

      Returns DataMarket

    • Parameters

      • unenvironmentedZenithCode: string
      • OptionalunknownAllowed: boolean

      Returns Exchange

    • Parameters

      • unenvironmentedZenithCode: string
      • OptionalunknownAllowed: boolean

      Returns MarketBoard

    • Parameters

      • unenvironmentedZenithCode: string
      • OptionalunknownAllowed: boolean

      Returns TradingMarket

    • Parameters

      • zenithCode: string
      • OptionalunknownAllowed: boolean

      Returns Exchange

    • Parameters

      • zenithCode: string
      • OptionalunknownAllowed: boolean

      Returns ExchangeEnvironment

    • Parameters

      • zenithCode: string
      • OptionalunknownAllowed: boolean
      • Optionalmarket: DataMarket

      Returns MarketBoard

    • Parameters

      • zenithCode: string
      • OptionalunknownAllowed: boolean

      Returns TradingMarket

    Settings

    Member Visibility

    On This Page

    Properties
    Methods