Engine
Defined in: js-xbbg/src/index.ts:898
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Engine(
host?,port?):Engine
Defined in: js-xbbg/src/index.ts:902
Parameters
Section titled “Parameters”string = 'localhost'
number = 8194
Returns
Section titled “Returns”Engine
Methods
Section titled “Methods”activeCdx()
Section titled “activeCdx()”activeCdx(
genTicker,dt,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1550
Parameters
Section titled “Parameters”genTicker
Section titled “genTicker”string
options?
Section titled “options?”ActiveCdxOptions = {}
Returns
Section titled “Returns”Promise<unknown>
activeFutures()
Section titled “activeFutures()”activeFutures(
genTicker,dt,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1515
Parameters
Section titled “Parameters”genTicker
Section titled “genTicker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<unknown>
bcurves()
Section titled “bcurves()”bcurves(
ticker,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1154
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”RequestOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bdh(
tickers,fields,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:978
Parameters
Section titled “Parameters”tickers
Section titled “tickers”readonly string[]
fields
Section titled “fields”readonly string[]
options?
Section titled “options?”BdhOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bdib()
Section titled “bdib()”bdib(
ticker,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:999
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”BdibOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bdp(
tickers,fields,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:939
Parameters
Section titled “Parameters”tickers
Section titled “tickers”readonly string[]
fields
Section titled “fields”readonly string[]
options?
Section titled “options?”BdpOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bds(
tickers,fields,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:959
Parameters
Section titled “Parameters”tickers
Section titled “tickers”readonly string[]
fields
Section titled “fields”readonly string[]
options?
Section titled “options?”BdpOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bdtick()
Section titled “bdtick()”bdtick(
ticker,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1016
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”BdtickOptions = {}
Returns
Section titled “Returns”Promise<unknown>
beqs()
Section titled “beqs()”beqs(
screen,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1044
Parameters
Section titled “Parameters”screen
Section titled “screen”string
options?
Section titled “options?”BeqsOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bflds()
Section titled “bflds()”bflds(
options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1100
Parameters
Section titled “Parameters”options?
Section titled “options?”BfldsOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bgovts()
Section titled “bgovts()”bgovts(
ticker,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1165
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”RequestOptions = {}
Returns
Section titled “Returns”Promise<unknown>
blkp()
Section titled “blkp()”blkp(
query,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1126
Parameters
Section titled “Parameters”string
options?
Section titled “options?”BlkpOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bops()
Section titled “bops()”bops(
service):Promise<string[]>
Defined in: js-xbbg/src/index.ts:1392
Parameters
Section titled “Parameters”service
Section titled “service”string
Returns
Section titled “Returns”Promise<string[]>
bport()
Section titled “bport()”bport(
portfolio,fields,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1137
Parameters
Section titled “Parameters”portfolio
Section titled “portfolio”string
fields
Section titled “fields”string | readonly string[]
options?
Section titled “options?”RequestOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bql(
query,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1032
Parameters
Section titled “Parameters”string
options?
Section titled “options?”BqlOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bqr(
ticker,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1424
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”BqrOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bschema()
Section titled “bschema()”bschema(
service,operation?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1396
Parameters
Section titled “Parameters”service
Section titled “service”string
operation?
Section titled “operation?”string
Returns
Section titled “Returns”Promise<unknown>
bsrch()
Section titled “bsrch()”bsrch(
searchSpec,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1069
Parameters
Section titled “Parameters”searchSpec
Section titled “searchSpec”string
options?
Section titled “options?”BsrchOptions = {}
Returns
Section titled “Returns”Promise<unknown>
bta(
ticker,study,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1085
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
string | RawStudy
options?
Section titled “options?”BtaOptions = {}
Returns
Section titled “Returns”Promise<unknown>
cdxTicker()
Section titled “cdxTicker()”cdxTicker(
genTicker,dt,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1533
Parameters
Section titled “Parameters”genTicker
Section titled “genTicker”string
options?
Section titled “options?”RecipeBackendOptions = {}
Returns
Section titled “Returns”Promise<unknown>
chains()
Section titled “chains()”chains(
ticker,options?):Promise<Subscription>
Defined in: js-xbbg/src/index.ts:1379
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”StreamOptions = {}
Returns
Section titled “Returns”Promise<Subscription>
clearFieldCache()
Section titled “clearFieldCache()”clearFieldCache():
void
Defined in: js-xbbg/src/index.ts:1193
Returns
Section titled “Returns”void
clearSchemaCache()
Section titled “clearSchemaCache()”clearSchemaCache():
void
Defined in: js-xbbg/src/index.ts:1232
Returns
Section titled “Returns”void
corporateBonds()
Section titled “corporateBonds()”corporateBonds(
ticker,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1479
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<unknown>
currencyConversion()
Section titled “currencyConversion()”currencyConversion(
ticker,targetCcy,startDate,endDate,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1625
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
targetCcy
Section titled “targetCcy”string
startDate
Section titled “startDate”endDate
Section titled “endDate”options?
Section titled “options?”RecipeBackendOptions = {}
Returns
Section titled “Returns”Promise<unknown>
depth()
Section titled “depth()”depth(
ticker,options?):Promise<Subscription>
Defined in: js-xbbg/src/index.ts:1366
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”StreamOptions = {}
Returns
Section titled “Returns”Promise<Subscription>
dividend()
Section titled “dividend()”dividend(
tickers,startDate,endDate,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1568
Parameters
Section titled “Parameters”tickers
Section titled “tickers”string | readonly string[]
startDate
Section titled “startDate”endDate
Section titled “endDate”options?
Section titled “options?”DividendOptions = {}
Returns
Section titled “Returns”Promise<unknown>
etfHoldings()
Section titled “etfHoldings()”etfHoldings(
etfTicker,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1609
Parameters
Section titled “Parameters”etfTicker
Section titled “etfTicker”string
options?
Section titled “options?”EtfHoldingsOptions = {}
Returns
Section titled “Returns”Promise<unknown>
fieldInfo()
Section titled “fieldInfo()”fieldInfo(
fields,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1405
Parameters
Section titled “Parameters”fields
Section titled “fields”string | readonly string[]
options?
Section titled “options?”BfldsOptions = {}
Returns
Section titled “Returns”Promise<unknown>
fieldSearch()
Section titled “fieldSearch()”fieldSearch(
searchSpec,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1415
Parameters
Section titled “Parameters”searchSpec
Section titled “searchSpec”string
options?
Section titled “options?”BfldsOptions = {}
Returns
Section titled “Returns”Promise<unknown>
futTicker()
Section titled “futTicker()”futTicker(
genTicker,dt,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1497
Parameters
Section titled “Parameters”genTicker
Section titled “genTicker”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<unknown>
getCachedSchema()
Section titled “getCachedSchema()”getCachedSchema(
service):unknown
Defined in: js-xbbg/src/index.ts:1223
Parameters
Section titled “Parameters”service
Section titled “service”string
Returns
Section titled “Returns”unknown
getEnumValues()
Section titled “getEnumValues()”getEnumValues(
service,operation,element):Promise<string[] |null>
Defined in: js-xbbg/src/index.ts:1240
Parameters
Section titled “Parameters”service
Section titled “service”string
operation
Section titled “operation”string
element
Section titled “element”string
Returns
Section titled “Returns”Promise<string[] | null>
getFieldInfo()
Section titled “getFieldInfo()”getFieldInfo(
field):FieldInfo|null
Defined in: js-xbbg/src/index.ts:1189
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”FieldInfo | null
getOperation()
Section titled “getOperation()”getOperation(
service,operation):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1214
Parameters
Section titled “Parameters”service
Section titled “service”string
operation
Section titled “operation”string
Returns
Section titled “Returns”Promise<unknown>
getSchema()
Section titled “getSchema()”getSchema(
service):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1209
Parameters
Section titled “Parameters”service
Section titled “service”string
Returns
Section titled “Returns”Promise<unknown>
invalidateSchema()
Section titled “invalidateSchema()”invalidateSchema(
service):void
Defined in: js-xbbg/src/index.ts:1228
Parameters
Section titled “Parameters”service
Section titled “service”string
Returns
Section titled “Returns”void
isAvailable()
Section titled “isAvailable()”isAvailable():
boolean
Defined in: js-xbbg/src/index.ts:1315
Returns
Section titled “Returns”boolean
isFieldValidationEnabled()
Section titled “isFieldValidationEnabled()”isFieldValidationEnabled():
boolean
Defined in: js-xbbg/src/index.ts:1205
Returns
Section titled “Returns”boolean
listCachedSchemas()
Section titled “listCachedSchemas()”listCachedSchemas():
string[]
Defined in: js-xbbg/src/index.ts:1236
Returns
Section titled “Returns”string[]
listOperations()
Section titled “listOperations()”listOperations(
service):Promise<string[]>
Defined in: js-xbbg/src/index.ts:1219
Parameters
Section titled “Parameters”service
Section titled “service”string
Returns
Section titled “Returns”Promise<string[]>
listValidElements()
Section titled “listValidElements()”listValidElements(
service,operation):Promise<string[] |null>
Defined in: js-xbbg/src/index.ts:1248
Parameters
Section titled “Parameters”service
Section titled “service”string
operation
Section titled “operation”string
Returns
Section titled “Returns”Promise<string[] | null>
mktbar()
Section titled “mktbar()”mktbar(
ticker,options?):Promise<Subscription>
Defined in: js-xbbg/src/index.ts:1353
Parameters
Section titled “Parameters”ticker
Section titled “ticker”string
options?
Section titled “options?”StreamOptions = {}
Returns
Section titled “Returns”Promise<Subscription>
preferreds()
Section titled “preferreds()”preferreds(
equityTicker,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1463
Parameters
Section titled “Parameters”equityTicker
Section titled “equityTicker”string
options?
Section titled “options?”PreferredsOptions = {}
Returns
Section titled “Returns”Promise<unknown>
request()
Section titled “request()”request(
params):Promise<unknown>
Defined in: js-xbbg/src/index.ts:920
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<unknown>
requestRaw()
Section titled “requestRaw()”requestRaw(
params):Promise<Buffer<ArrayBufferLike>>
Defined in: js-xbbg/src/index.ts:931
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Buffer<ArrayBufferLike>>
resolveFieldTypes()
Section titled “resolveFieldTypes()”resolveFieldTypes(
fields,overrides?,defaultType?):Promise<Record<string,string>>
Defined in: js-xbbg/src/index.ts:1176
Parameters
Section titled “Parameters”fields
Section titled “fields”readonly string[]
overrides?
Section titled “overrides?”defaultType?
Section titled “defaultType?”string = 'string'
Returns
Section titled “Returns”Promise<Record<string, string>>
saveFieldCache()
Section titled “saveFieldCache()”saveFieldCache():
void
Defined in: js-xbbg/src/index.ts:1197
Returns
Section titled “Returns”void
signalShutdown()
Section titled “signalShutdown()”signalShutdown():
void
Defined in: js-xbbg/src/index.ts:1311
Returns
Section titled “Returns”void
stream()
Section titled “stream()”stream(
tickers,fields,options?):Promise<Subscription>
Defined in: js-xbbg/src/index.ts:1319
Parameters
Section titled “Parameters”tickers
Section titled “tickers”readonly string[]
fields
Section titled “fields”readonly string[]
options?
Section titled “options?”StreamOptions = {}
Returns
Section titled “Returns”Promise<Subscription>
subscribe()
Section titled “subscribe()”subscribe(
tickers,fields,options?):Promise<Subscription>
Defined in: js-xbbg/src/index.ts:1255
Parameters
Section titled “Parameters”tickers
Section titled “tickers”readonly string[]
fields
Section titled “fields”readonly string[]
options?
Section titled “options?”StreamOptions = {}
Returns
Section titled “Returns”Promise<Subscription>
subscribeWithOptions()
Section titled “subscribeWithOptions()”subscribeWithOptions(
service,tickers,fields,options?,flushThreshold?,overflowPolicy?,streamCapacity?,allFields?):Promise<Subscription>
Defined in: js-xbbg/src/index.ts:1284
Parameters
Section titled “Parameters”service
Section titled “service”string
tickers
Section titled “tickers”readonly string[]
fields
Section titled “fields”readonly string[]
options?
Section titled “options?”readonly string[]
flushThreshold?
Section titled “flushThreshold?”number
overflowPolicy?
Section titled “overflowPolicy?”string
streamCapacity?
Section titled “streamCapacity?”number
allFields?
Section titled “allFields?”boolean
Returns
Section titled “Returns”Promise<Subscription>
turnover()
Section titled “turnover()”turnover(
tickers,startDate,endDate,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1588
Parameters
Section titled “Parameters”tickers
Section titled “tickers”string | readonly string[]
startDate
Section titled “startDate”endDate
Section titled “endDate”options?
Section titled “options?”TurnoverOptions = {}
Returns
Section titled “Returns”Promise<unknown>
validateFields()
Section titled “validateFields()”validateFields(
fields):Promise<string[]>
Defined in: js-xbbg/src/index.ts:1201
Parameters
Section titled “Parameters”fields
Section titled “fields”readonly string[]
Returns
Section titled “Returns”Promise<string[]>
vwap()
Section titled “vwap()”vwap(
tickers,fields,options?):Promise<Subscription>
Defined in: js-xbbg/src/index.ts:1336
Parameters
Section titled “Parameters”tickers
Section titled “tickers”readonly string[]
fields
Section titled “fields”readonly string[]
options?
Section titled “options?”StreamOptions = {}
Returns
Section titled “Returns”Promise<Subscription>
yas(
tickers,fields,options?):Promise<unknown>
Defined in: js-xbbg/src/index.ts:1440
Parameters
Section titled “Parameters”tickers
Section titled “tickers”string | readonly string[]
fields
Section titled “fields”string | readonly string[]
options?
Section titled “options?”YasOptions = {}
Returns
Section titled “Returns”Promise<unknown>
withConfig()
Section titled “withConfig()”
staticwithConfig(config?):Engine
Defined in: js-xbbg/src/index.ts:910
Parameters
Section titled “Parameters”config?
Section titled “config?”EngineConfig = {}
Returns
Section titled “Returns”Engine