Skip to content

ExtNamespace ​

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

Properties ​

cdx ​

cdx: CdxNamespace

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

Methods ​

buildCorporateBondsQuery() ​

buildCorporateBondsQuery(ticker, ccy?, extraFields?, activeOnly?): string

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

Parameters ​

ticker ​

string

ccy? ​

string

extraFields? ​

string[]

activeOnly? ​

boolean

Returns ​

string


buildEarningHeaderRename() ​

buildEarningHeaderRename(headerRow, dataColumns): StringPair[]

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

Parameters ​

headerRow ​

StringPair[]

dataColumns ​

string[]

Returns ​

StringPair[]


buildEtfHoldingsQuery() ​

buildEtfHoldingsQuery(etfTicker, extraFields?): string

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

Parameters ​

etfTicker ​

string

extraFields? ​

string[]

Returns ​

string


buildFuturesTicker() ​

buildFuturesTicker(prefix, monthCode, year, asset): string

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

Parameters ​

prefix ​

string

monthCode ​

string

year ​

string

asset ​

string

Returns ​

string


buildFxPair() ​

buildFxPair(fromCcy, toCcy): FxPairInfo

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

Parameters ​

fromCcy ​

string

toCcy ​

string

Returns ​

FxPairInfo


buildPreferredsQuery() ​

buildPreferredsQuery(equityTicker, extraFields?): string

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

Parameters ​

equityTicker ​

string

extraFields? ​

string[]

Returns ​

string


buildYasOverrides() ​

buildYasOverrides(settleDt?, yieldType?, spread?, yieldVal?, price?, benchmark?): StringPair[]

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

Parameters ​

settleDt? ​

string

yieldType? ​

number

spread? ​

number

yieldVal? ​

number

price? ​

number

benchmark? ​

string

Returns ​

StringPair[]


calculateLevelPercentages() ​

calculateLevelPercentages(values, levels): (number | null)[]

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

Parameters ​

values ​

(number | null)[]

levels ​

(number | null)[]

Returns ​

(number | null)[]


cdxGenToSpecific() ​

cdxGenToSpecific(genTicker, series): string

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

Parameters ​

genTicker ​

string

series ​

number

Returns ​

string


clearExchangeOverride() ​

clearExchangeOverride(ticker?): void

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

Parameters ​

ticker? ​

string

Returns ​

void


contractIndex() ​

contractIndex(genTicker): number

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

Parameters ​

genTicker ​

string

Returns ​

number


currenciesNeedingConversion() ​

currenciesNeedingConversion(currencies, target): string[]

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

Parameters ​

currencies ​

string[]

target ​

string

Returns ​

string[]


defaultBqrDatetimes() ​

defaultBqrDatetimes(startDatetime?, endDatetime?): TimeRange

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

Parameters ​

startDatetime? ​

string

endDatetime? ​

string

Returns ​

TimeRange


defaultTurnoverDates() ​

defaultTurnoverDates(startDate?, endDate?): TimeRange

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

Parameters ​

startDate? ​

string

endDate? ​

string

Returns ​

TimeRange


deriveSessions() ​

deriveSessions(dayStart, dayEnd, mic?, exchCode?): SessionWindowsInfo

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

Parameters ​

dayStart ​

string

dayEnd ​

string

mic? ​

string

exchCode? ​

string

Returns ​

SessionWindowsInfo


filterCandidatesByCycle() ​

filterCandidatesByCycle(candidates, cycle): FuturesCandidate[]

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

Parameters ​

candidates ​

FuturesCandidate[]

cycle ​

string

Returns ​

FuturesCandidate[]


filterEquityTickers() ​

filterEquityTickers(tickers): string[]

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

Parameters ​

tickers ​

string[]

Returns ​

string[]


filterValidContracts() ​

filterValidContracts(contracts, year, month, day): string[]

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

Parameters ​

contracts ​

StringPair[]

year ​

number

month ​

number

day ​

number

Returns ​

string[]


fmtDate() ​

fmtDate(year, month, day, fmt?): string

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

Parameters ​

year ​

number

month ​

number

day ​

number

fmt? ​

string

Returns ​

string


generateFuturesCandidates() ​

generateFuturesCandidates(genTicker, year, month, day, freq?, count?): FuturesCandidate[]

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

Parameters ​

genTicker ​

string

year ​

number

month ​

number

day ​

number

freq? ​

string

count? ​

number

Returns ​

FuturesCandidate[]


getDvdCols() ​

getDvdCols(): StringPair[]

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

Returns ​

StringPair[]


getDvdType() ​

getDvdType(typ): string | null

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

Parameters ​

typ ​

string

Returns ​

string | null


getDvdTypes() ​

getDvdTypes(): StringPair[]

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

Returns ​

StringPair[]


getEtfCols() ​

getEtfCols(): StringPair[]

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

Returns ​

StringPair[]


getExchangeOverride() ​

getExchangeOverride(ticker): ExchangeInfoResult | null

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

Parameters ​

ticker ​

string

Returns ​

ExchangeInfoResult | null


getFuturesMonths() ​

getFuturesMonths(): StringPair[]

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

Returns ​

StringPair[]


getMarketRule() ​

getMarketRule(mic?, exchCode?): MarketRule | null

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

Parameters ​

mic? ​

string

exchCode? ​

string

Returns ​

MarketRule | null


getMonthCode() ​

getMonthCode(monthName): string | null

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

Parameters ​

monthName ​

string

Returns ​

string | null


getMonthName() ​

getMonthName(code): string | null

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

Parameters ​

code ​

string

Returns ​

string | null


inferTimezone() ​

inferTimezone(countryIso): string | null

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

Parameters ​

countryIso ​

string

Returns ​

string | null


isLongFormat() ​

isLongFormat(ipcBuffer): boolean

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

Parameters ​

ipcBuffer ​

Buffer

Returns ​

boolean


isSpecificContract() ​

isSpecificContract(ticker): boolean

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

Parameters ​

ticker ​

string

Returns ​

boolean


listExchangeOverrides() ​

listExchangeOverrides(): ExchangeInfoResult[]

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

Returns ​

ExchangeInfoResult[]


normalizeTickers() ​

normalizeTickers(tickers): string[]

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

Parameters ​

tickers ​

string[]

Returns ​

string[]


parseCdxTicker() ​

parseCdxTicker(ticker): CdxTickerInfo

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

Parameters ​

ticker ​

string

Returns ​

CdxTickerInfo


parseDate() ​

parseDate(dateStr): number[]

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

Parameters ​

dateStr ​

string

Returns ​

number[]


parseTicker() ​

parseTicker(ticker): TickerParts

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

Parameters ​

ticker ​

string

Returns ​

TickerParts


pivotToWide() ​

pivotToWide(ipcBuffer): Buffer

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

Parameters ​

ipcBuffer ​

Buffer

Returns ​

Buffer


previousCdxSeries() ​

previousCdxSeries(ticker): string | null

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

Parameters ​

ticker ​

string

Returns ​

string | null


renameDividendColumns() ​

renameDividendColumns(columns): StringPair[]

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

Parameters ​

columns ​

string[]

Returns ​

StringPair[]


renameEtfColumns() ​

renameEtfColumns(columns): StringPair[]

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

Parameters ​

columns ​

string[]

Returns ​

StringPair[]


sameCurrency() ​

sameCurrency(ccy1, ccy2): boolean

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

Parameters ​

ccy1 ​

string

ccy2 ​

string

Returns ​

boolean


sessionTimesToUtc() ​

sessionTimesToUtc(startTime, endTime, exchangeTz, date): TimeRange

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

Parameters ​

startTime ​

string

endTime ​

string

exchangeTz ​

string

date ​

string

Returns ​

TimeRange


setExchangeOverride() ​

setExchangeOverride(ticker, input): void

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

Parameters ​

ticker ​

string

input ​

ExchangeOverrideInput

Returns ​

void


validateGenericTicker() ​

validateGenericTicker(ticker): void

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

Parameters ​

ticker ​

string

Returns ​

void

Last updated:

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