Properties
eventEmitter
event
Emitter
: StrictEventEmitter<EventEmitter<DefaultEventMap>, DLOBSubscriberEvents, DLOBSubscriberEvents, "addEventListener" | "removeEventListener", "on" | "addListener" | "removeListener" | "once" | "emit">Optional intervalId
intervalId?: Timeout
updateFrequency
updateFrequency: number
Methods
getL2
- getL2(__namedParameters: {
depth?: number;
fallbackL2Generators?: L2OrderBookGenerator[];
includeVamm?: boolean;
marketIndex?: number;
marketName?: string;
marketType?: MarketType;
numVammOrders?: number;
}): L2OrderBook
-
Parameters
-
__namedParameters: {
depth?: number;
fallbackL2Generators?: L2OrderBookGenerator[];
includeVamm?: boolean;
marketIndex?: number;
marketName?: string;
marketType?: MarketType;
numVammOrders?: number;
}
-
Optional depth?: number
-
-
Optional includeVamm?: boolean
-
Optional marketIndex?: number
-
Optional marketName?: string
-
Optional marketType?: MarketType
-
Optional numVammOrders?: number
getL3
- getL3(__namedParameters: {
marketIndex?: number;
marketName?: string;
marketType?: MarketType;
}): L3OrderBook
-
Parameters
-
__namedParameters: {
marketIndex?: number;
marketName?: string;
marketType?: MarketType;
}
-
Optional marketIndex?: number
-
Optional marketName?: string
-
Optional marketType?: MarketType
subscribe
- subscribe(): Promise<void>
-
Returns Promise<void>
unsubscribe
- unsubscribe(): Promise<void>
-
Returns Promise<void>
updateDLOB
- updateDLOB(): Promise<void>
-
Returns Promise<void>
Get the L2 order book for a given market.