Package com.bookmap.js.api

Interface JsApi

All Superinterfaces:

Api

public interface JsApi
extends Api

Method Summary

Modifier and Type	Method	Description
void	addConsolidatedTradeDataListener(TradeDataListener listener)	Adds a listener to the Stop orders tracker.
void	addIcebergOrderIdListener(java.util.function.Consumer<java.lang.String> listener)	Adds a listener to the Iceberg orders tracker.
void	addIcebergOrderListener(OrderListener listener)	Adds a listener to the Iceberg orders tracker.
void	addStopOrderIdListener(java.util.function.Consumer<java.lang.String> listener)	Adds a listener to the Stop orders tracker.
java.lang.String	getAlias()	returns Instrument's alias as provided by CustomModule.initialize(String, InstrumentInfo, Api, InitialState)
InitialState	getInitialState()	returns InitialState object as provided by CustomModule.initialize(String, InstrumentInfo, Api, InitialState)
velox.api.layer1.data.InstrumentInfo	getInstrumentInfo()	returns InstrumentInfo object as provided by CustomModule.initialize(String, InstrumentInfo, Api, InitialState)
Indicator	registerIndicator(IndicatorProperties properties)	Creates Indicator with provided settings

Methods inherited from interface velox.api.layer1.simplified.Api

addBalanceListeners, addBarDataListeners, addBboDataListeners, addDepthDataListeners, addHistoricalModeListeners, addIntervalListeners, addMarketByOrderDepthDataListeners, addMultiInstrumentListeners, addOrdersListeners, addSnapshotEndListeners, addStatusListeners, addTimeListeners, addTradeDataListeners, getProvider, getSettings, registerIndicator, registerIndicator, registerIndicatorModifiable, registerIndicatorModifiable, reload, sendOrder, sendUserMessage, setSettings, unload, updateOrder

Method Details

getAlias

java.lang.String getAlias()

returns Instrument's alias as provided by CustomModule.initialize(String, InstrumentInfo, Api, InitialState)

Returns:

Instrument's alias as provided by CustomModule.initialize(String, InstrumentInfo, Api, InitialState)

getInstrumentInfo

velox.api.layer1.data.InstrumentInfo getInstrumentInfo()

returns InstrumentInfo object as provided by CustomModule.initialize(String, InstrumentInfo, Api, InitialState)

Returns:

InstrumentInfo object as provided by CustomModule.initialize(String, InstrumentInfo, Api, InitialState)

getInitialState

InitialState getInitialState()

returns InitialState object as provided by CustomModule.initialize(String, InstrumentInfo, Api, InitialState)

Returns:

InitialState object as provided by CustomModule.initialize(String, InstrumentInfo, Api, InitialState)

addIcebergOrderIdListener

void addIcebergOrderIdListener(java.util.function.Consumer<java.lang.String> listener)

Adds a listener to the Iceberg orders tracker. The listener will receive the order id of each newly detected Iceberg order. This callback is invoked just once per order regardless of number of trades and/or updates of the order which may have occurred before and after it was identified as an Iceberg order

Parameters:

listener - a listener to order id of newly detected Iceberg orders

addIcebergOrderListener

void addIcebergOrderListener(OrderListener listener)

Adds a listener to the Iceberg orders tracker. The listener will receive MBO and Trades events for all iceberg orders

Parameters:

listener - a listener to order id of newly detected Iceberg orders

addStopOrderIdListener

void addStopOrderIdListener(java.util.function.Consumer<java.lang.String> listener)

Adds a listener to the Stop orders tracker. The listener will receive the order id of each newly detected Stop order. This callback is invoked just once per order regardless of number of trades and/or updates of the order which may have occurred before and after it was identified as a Stop order

Parameters:

listener - a listener to order id of newly detected Iceberg orders

addConsolidatedTradeDataListener

void addConsolidatedTradeDataListener(TradeDataListener listener)

Adds a listener to the Stop orders tracker. The listener will receive onTrade events for either all trades or trades of Stop orders only

Parameters:

listener - a listener to consolidated trade events

registerIndicator

Indicator registerIndicator(IndicatorProperties properties)

Creates Indicator with provided settings

Parameters:

properties - IndicatorProperties object with desired settings

Returns:

registered Indicator or IndicatorModifiable depending on IndicatorProperties.isModifiable()