Node.js installation

Install @xbbg/core.

The public npm package resolves a supported native addon, then connects to the same Rust/Arrow engine used by Python.

Install from a package manager

npm

npm install @xbbg/core

bun

bun add @xbbg/core

Package page: npm / @xbbg/core

@xbbg/core loads a packaged native addon through platform-specific optional dependencies on supported targets.

Supported prebuilt addon targets

• macOS arm64
• Linux x64
• Windows x64

INFO

The platform-specific @xbbg/core-* packages are installation artifacts behind @xbbg/core. Public docs stay centered on @xbbg/core itself.

Bloomberg connectivity

After install, point the package at the Bloomberg endpoint you use:

import * as xbbg from '@xbbg/core';

xbbg.configure({
  host: 'localhost',
  port: 8194,
});

For B-PIPE, leased-line, or advanced auth scenarios, connect() and configure() accept the structured EngineConfig object exposed by the package. Direct B-PIPE hosts use host / port or servers; ZFP over leased lines uses zfpRemote: '8194' | '8196' plus tls credentials and must not be combined with direct hosts or SOCKS5.

Verify the package surface

import * as xbbg from '@xbbg/core';

console.log(xbbg.version());
console.log(xbbg.blp);
console.log(xbbg.ext);

Unsupported platforms or source builds

If you need to build the addon yourself, follow the repository instructions in js-xbbg/README.md. The public docs stay focused on the installable package; contributor and unsupported-platform workflows live in the package README.

Next steps

JavaScript overview

Understand the public Node.js surface.

Package Map

Choose between xbbg and @xbbg/core.

API Reference

Browse the generated TypeScript reference.