xbbg

Appearance

Engine ​

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:315)

Constructors ​

Constructor ​

new Engine(host?, port?): Engine

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:316)

Parameters ​

host? ​

string

port? ​

number

Returns ​

Engine

Methods ​

activeCdx() ​

activeCdx(genTicker, dt, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:435)

Parameters ​

genTicker ​

string

dt ​

string

options? ​

ActiveCdxOptions

Returns ​

Promise<Table<any>>

activeFutures() ​

activeFutures(genTicker, dt, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:425)

Parameters ​

genTicker ​

string

dt ​

string

options? ​

FuturesResolveOptions

Returns ​

Promise<Table<any>>

bcurves() ​

bcurves(ticker, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:390)

Parameters ​

ticker ​

string

options? ​

RequestOptions

Returns ​

Promise<Table<any>>

bdh() ​

bdh(tickers, fields, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:330)

Parameters ​

tickers ​

string[]

fields ​

string[]

options? ​

BdhOptions

Returns ​

Promise<Table<any>>

bdib() ​

bdib(ticker, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:335)

Parameters ​

ticker ​

string

options? ​

BdibOptions

Returns ​

Promise<Table<any>>

bdp() ​

bdp(tickers, fields, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:320)

Parameters ​

tickers ​

string[]

fields ​

string[]

options? ​

BdpOptions

Returns ​

Promise<Table<any>>

bds() ​

bds(tickers, fields, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:325)

Parameters ​

tickers ​

string[]

fields ​

string[]

options? ​

BdpOptions

Returns ​

Promise<Table<any>>

bdtick() ​

bdtick(ticker, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:336)

Parameters ​

ticker ​

string

options? ​

BdtickOptions

Returns ​

Promise<Table<any>>

beqs() ​

beqs(screen, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:376)

Parameters ​

screen ​

string

options? ​

BeqsOptions

Returns ​

Promise<Table<any>>

bflds() ​

bflds(options): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:383)

Parameters ​

options ​

BfldsOptions

Returns ​

Promise<Table<any>>

bgovts() ​

bgovts(ticker, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:391)

Parameters ​

ticker ​

string

options? ​

RequestOptions

Returns ​

Promise<Table<any>>

blkp() ​

blkp(query, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:384)

Parameters ​

query ​

string

options? ​

BlkpOptions

Returns ​

Promise<Table<any>>

bops() ​

bops(service): Promise<string[]>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:405)

Parameters ​

service ​

string

Returns ​

Promise<string[]>

bport() ​

bport(portfolio, fields, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:385)

Parameters ​

portfolio ​

string

Bloomberg PortfolioDataRequest security/portfolio ID string, not the PORT display name (for example, UXXXXXXX-X Client from PRTU/PORT).

fields ​

string | string[]

options? ​

RequestOptions

Returns ​

Promise<Table<any>>

bql() ​

bql(query, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:375)

Parameters ​

query ​

string

options? ​

BqlOptions

Returns ​

Promise<Table<any>>

bqr() ​

bqr(ticker, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:409)

Parameters ​

ticker ​

string

options? ​

BqrOptions

Returns ​

Promise<Table<any>>

bschema() ​

bschema(service, operation?): Promise<unknown>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:406)

Parameters ​

service ​

string

operation? ​

string

Returns ​

Promise<unknown>

bsrch() ​

bsrch(searchSpec, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:377)

Parameters ​

searchSpec ​

string

options? ​

BsrchOptions

Returns ​

Promise<Table<any>>

bta() ​

bta(ticker, study, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:378)

Parameters ​

ticker ​

string

study ​

string | Record<string, unknown>

options? ​

BtaOptions

Returns ​

Promise<Table<any>>

cdxTicker() ​

cdxTicker(genTicker, dt, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:430)

Parameters ​

genTicker ​

string

dt ​

string

options? ​

RecipeBackendOptions

Returns ​

Promise<Table<any>>

chains() ​

chains(ticker, options?): Promise<Subscription>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:404)

Parameters ​

ticker ​

string

options? ​

StreamOptions

Returns ​

Promise<Subscription>

clearFieldCache() ​

clearFieldCache(): void

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:343)

Returns ​

void

clearSchemaCache() ​

clearSchemaCache(): void

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:352)

Returns ​

void

corporateBonds() ​

corporateBonds(ticker, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:416)

Parameters ​

ticker ​

string

options? ​

CorporateBondsOptions

Returns ​

Promise<Table<any>>

currencyConversion() ​

currencyConversion(ticker, targetCcy, startDate, endDate, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:453)

Parameters ​

ticker ​

string

targetCcy ​

string

startDate ​

string

endDate ​

string

options? ​

RecipeBackendOptions

Returns ​

Promise<Table<any>>

depth() ​

depth(ticker, options?): Promise<Subscription>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:403)

Parameters ​

ticker ​

string

options? ​

StreamOptions

Returns ​

Promise<Subscription>

dividend() ​

dividend(tickers, startDate, endDate, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:440)

Parameters ​

tickers ​

string | string[]

startDate ​

string

endDate ​

string

options? ​

DividendOptions

Returns ​

Promise<Table<any>>

etfHoldings() ​

etfHoldings(etfTicker, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:452)

Parameters ​

etfTicker ​

string

options? ​

EtfHoldingsOptions

Returns ​

Promise<Table<any>>

fieldInfo() ​

fieldInfo(fields, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:407)

Parameters ​

fields ​

string | string[]

options? ​

BfldsOptions

Returns ​

Promise<Table<any>>

fieldSearch() ​

fieldSearch(searchSpec, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:408)

Parameters ​

searchSpec ​

string

options? ​

BfldsOptions

Returns ​

Promise<Table<any>>

futTicker() ​

futTicker(genTicker, dt, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:420)

Parameters ​

genTicker ​

string

dt ​

string

options? ​

FuturesResolveOptions

Returns ​

Promise<Table<any>>

getCachedSchema() ​

getCachedSchema(service): unknown

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:350)

Parameters ​

service ​

string

Returns ​

unknown

getEnumValues() ​

getEnumValues(service, operation, element): Promise<string[] | null>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:354)

Parameters ​

service ​

string

operation ​

string

element ​

string

Returns ​

Promise<string[] | null>

getFieldInfo() ​

getFieldInfo(field): FieldInfo | null

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:342)

Parameters ​

field ​

string

Returns ​

FieldInfo | null

getOperation() ​

getOperation(service, operation): Promise<unknown>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:348)

Parameters ​

service ​

string

operation ​

string

Returns ​

Promise<unknown>

getSchema() ​

getSchema(service): Promise<unknown>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:347)

Parameters ​

service ​

string

Returns ​

Promise<unknown>

invalidateSchema() ​

invalidateSchema(service): void

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:351)

Parameters ​

service ​

string

Returns ​

void

isAvailable() ​

isAvailable(): boolean

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:374)

Returns ​

boolean

isFieldValidationEnabled() ​

isFieldValidationEnabled(): boolean

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:346)

Returns ​

boolean

listCachedSchemas() ​

listCachedSchemas(): string[]

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:353)

Returns ​

string[]

listOperations() ​

listOperations(service): Promise<string[]>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:349)

Parameters ​

service ​

string

Returns ​

Promise<string[]>

listValidElements() ​

listValidElements(service, operation): Promise<string[] | null>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:359)

Parameters ​

service ​

string

operation ​

string

Returns ​

Promise<string[] | null>

mktbar() ​

mktbar(ticker, options?): Promise<Subscription>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:402)

Parameters ​

ticker ​

string

options? ​

StreamOptions

Returns ​

Promise<Subscription>

preferreds() ​

preferreds(equityTicker, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:415)

Parameters ​

equityTicker ​

string

options? ​

PreferredsOptions

Returns ​

Promise<Table<any>>

request() ​

request(params): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:318)

Parameters ​

params ​

RequestInput

Returns ​

Promise<Table<any>>

requestRaw() ​

requestRaw(params): Promise<Buffer<ArrayBufferLike>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:319)

Parameters ​

params ​

RequestInput

Returns ​

Promise<Buffer<ArrayBufferLike>>

resolveFieldTypes() ​

resolveFieldTypes(fields, overrides?, defaultType?): Promise<Record<string, string>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:337)

Parameters ​

fields ​

string[]

overrides? ​

Record<string, string | number | boolean>

defaultType? ​

string

Returns ​

Promise<Record<string, string>>

saveFieldCache() ​

saveFieldCache(): void

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:344)

Returns ​

void

signalShutdown() ​

signalShutdown(): void

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:373)

Returns ​

void

stream() ​

stream(tickers, fields, options?): Promise<Subscription>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:392)

Parameters ​

tickers ​

string[]

fields ​

string[]

options? ​

StreamOptions

Returns ​

Promise<Subscription>

subscribe() ​

subscribe(tickers, fields): Promise<Subscription>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:363)

Parameters ​

tickers ​

string[]

fields ​

string[]

Returns ​

Promise<Subscription>

subscribeWithOptions() ​

subscribeWithOptions(service, tickers, fields, options?, flushThreshold?, overflowPolicy?, streamCapacity?): Promise<Subscription>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:364)

Parameters ​

service ​

string

tickers ​

string[]

fields ​

string[]

options? ​

string[]

flushThreshold? ​

number

overflowPolicy? ​

string

streamCapacity? ​

number

Returns ​

Promise<Subscription>

turnover() ​

turnover(tickers, startDate, endDate, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:446)

Parameters ​

tickers ​

string | string[]

startDate ​

string

endDate ​

string

options? ​

TurnoverOptions

Returns ​

Promise<Table<any>>

validateFields() ​

validateFields(fields): Promise<string[]>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:345)

Parameters ​

fields ​

string[]

Returns ​

Promise<string[]>

vwap() ​

vwap(tickers, fields, options?): Promise<Subscription>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:397)

Parameters ​

tickers ​

string[]

fields ​

string[]

options? ​

StreamOptions

Returns ​

Promise<Subscription>

yas() ​

yas(tickers, fields, options?): Promise<Table<any>>

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:410)

Parameters ​

tickers ​

string | string[]

fields ​

string | string[]

options? ​

YasOptions

Returns ​

Promise<Table<any>>

withConfig() ​

static withConfig(config?): Engine

Defined in: js-xbbg/src/index.ts (declaration: index.d.ts:317)

Parameters ​

config? ​

EngineConfig

Returns ​

Engine

Last updated:

xbbg is independent open-source software and is not affiliated with, endorsed by, sponsored by, or approved by Bloomberg Finance L.P.

Bloomberg and related marks are trademarks or service marks of Bloomberg Finance L.P. or its affiliates. Use of Bloomberg data, APIs, and SDKs requires appropriate Bloomberg licenses and entitlements.