Binance Connector JS
    Preparing search index...

    MarketApi - interface MarketApi

    interface MarketApiInterface {
        aggregateTradeStreams(
            requestParameters: DerivativesTradingUsdsFuturesWebsocketStreams.AggregateTradeStreamsRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.AggregateTradeStreamsResponse,
        >;
        allMarketLiquidationOrderStreams(
            requestParameters?: DerivativesTradingUsdsFuturesWebsocketStreams.AllMarketLiquidationOrderStreamsRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.AllMarketLiquidationOrderStreamsResponse,
        >;
        allMarketMiniTickersStream(
            requestParameters?: DerivativesTradingUsdsFuturesWebsocketStreams.AllMarketMiniTickersStreamRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.AllMarketMiniTickersStreamResponse,
        >;
        allMarketTickersStreams(
            requestParameters?: DerivativesTradingUsdsFuturesWebsocketStreams.AllMarketTickersStreamsRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.AllMarketTickersStreamsResponse,
        >;
        compositeIndexSymbolInformationStreams(
            requestParameters: CompositeIndexSymbolInformationStreamsRequest,
        ): WebsocketStream<CompositeIndexSymbolInformationStreamsResponse>;
        continuousContractKlineCandlestickStreams(
            requestParameters: DerivativesTradingUsdsFuturesWebsocketStreams.ContinuousContractKlineCandlestickStreamsRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.ContinuousContractKlineCandlestickStreamsResponse,
        >;
        contractInfoStream(
            requestParameters?: DerivativesTradingUsdsFuturesWebsocketStreams.ContractInfoStreamRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.ContractInfoStreamResponse,
        >;
        individualSymbolMiniTickerStream(
            requestParameters: DerivativesTradingUsdsFuturesWebsocketStreams.IndividualSymbolMiniTickerStreamRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.IndividualSymbolMiniTickerStreamResponse,
        >;
        individualSymbolTickerStreams(
            requestParameters: DerivativesTradingUsdsFuturesWebsocketStreams.IndividualSymbolTickerStreamsRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.IndividualSymbolTickerStreamsResponse,
        >;
        klineCandlestickStreams(
            requestParameters: DerivativesTradingUsdsFuturesWebsocketStreams.KlineCandlestickStreamsRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.KlineCandlestickStreamsResponse,
        >;
        liquidationOrderStreams(
            requestParameters: DerivativesTradingUsdsFuturesWebsocketStreams.LiquidationOrderStreamsRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.LiquidationOrderStreamsResponse,
        >;
        markPriceStream(
            requestParameters: DerivativesTradingUsdsFuturesWebsocketStreams.MarkPriceStreamRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.MarkPriceStreamResponse,
        >;
        markPriceStreamForAllMarket(
            requestParameters?: MarkPriceStreamForAllMarketRequest,
        ): WebsocketStream<MarkPriceStreamForAllMarketResponse>;
        multiAssetsModeAssetIndex(
            requestParameters?: DerivativesTradingUsdsFuturesWebsocketStreams.MultiAssetsModeAssetIndexRequest,
        ): WebsocketStream<
            DerivativesTradingUsdsFuturesWebsocketStreams.MultiAssetsModeAssetIndexResponse,
        >;
        tradingSessionStream(
            requestParameters?: TradingSessionStreamRequest,
        ): WebsocketStream<TradingSessionStreamResponse>;
    }

    Implemented by

    Index

    Methods

    • Trading session information for the underlying assets of TradFi Perpetual contracts, covering the U.S. equity market, Korean equity market, and the commodity market, is updated every second. Trading session information for different underlying markets is pushed in separate messages.

      Event type:*

      • EquityUpdate: Session types for the U.S. equity market include "PRE_MARKET", "REGULAR", "AFTER_MARKET", "OVERNIGHT", and "NO_TRADING".
      • CommodityUpdate: Session types for the commodity market include "REGULAR" and "NO_TRADING".
      • KR_EquityUpdate: Session types for the Korean equity market include "REGULAR" and "NO_TRADING".

      Update Speed: 1s

      Parameters

      Returns WebsocketStream<TradingSessionStreamResponse>

      MarketApiInterface