Skip to content
xbbg logo xbbg

Installation

Install from a package manager

Section titled “Install from a package manager”
Terminal window
npm install @xbbg/core

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

Supported prebuilt addon targets

Section titled “Supported prebuilt addon targets”
  • macOS arm64
  • Linux x64
  • Windows x64

Bloomberg connectivity

Section titled “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.

Unsupported platforms or source builds

Section titled “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

Section titled “Next steps”
  • JavaScript overview — understand the public Node.js surface
  • Package Map — choose between xbbg and @xbbg/core
  • Browse the @xbbg/core API section in the sidebar for the generated TypeScript reference