Interface IDEXSubscribePublicBase

Base Type

This is generally not meant to be used directly by SDK users, they are used to augment interfaces with common parameters & documentation.

A Base type that all public WebSocket subscriptions extend upon.

See

names SubscriptionNamePublic
related IDEXSubscribeTypePublic

interface IDEXSubscribePublicBase {
    name: SubscriptionNamePublic;
    markets?: string[];
    interval?: CandleInterval;
}

Hierarchy (view full)

IDEXSubscribeBase
- IDEXSubscribePublicBase

Index

Properties

name markets? interval?

Properties

name

name: SubscriptionNamePublic

Subscription to subscribe to.

See

related SubscriptionNamePublic
related SubscriptionNameAuthenticated

`Optional` markets

markets?: string[]

Array of Market Symbols

Overrides the markets array at the top-level subscription object, if provided.
Required if the top-level subscription does not define markets and the request is a public subscription

`Optional` interval

interval?: CandleInterval

Candle Interval to subscribe to

Only applicable for candles subscription

See

enum CandleInterval