Instant Bloomberg

The Instant Bloomberg Adapter registers a set of Interop methods that allow io.Connect apps to interact with the Bloomberg IB Connect API — discover streams, subscribe for real-time messages, send ideas, initiate chats, and more. The Instant Bloomberg Adapter also exposes an Interop stream for monitoring its status.

To invoke a method, use io.interop.invoke() with the method name and an arguments object:

const methodName = "IO.BBG.IB_Chat.GetStreams";

const result = await io.interop.invoke(methodName);

console.log(result.returned);
// { allStreams: ["stream-1", "stream-2"] }

Interop methods related to Instant Bloomberg streams.

IO.BBG.IB_Chat.GetLastMessages

Retrieves cached messages for a stream. Optionally accepts a backfillId to return only messages after that point.

The IO.BBG.IB_Chat.GetLastMessages method accepts as an argument an object with the following properties:

The IO.BBG.IB_Chat.GetLastMessages method returns as a result an object with the following properties:

IO.BBG.IB_Chat.GetStatusStream

Pushes service status updates periodically (at the interval configured via healthCheckInterval) and on status change.

To subscribe to the stream:

const subscription = await io.interop.subscribe("IO.BBG.IB_Chat.GetStatusStream");

subscription.onData((data) => {
    console.log(data.data);
    // { isRunning: true, timestamp: "2026-03-09T12:00:00.000Z" }
});

Each status update contains the following properties:

IO.BBG.IB_Chat.GetStreams

Discovers all visible IB Chat streams.

The IO.BBG.IB_Chat.GetStreams method accepts no arguments.

The IO.BBG.IB_Chat.GetStreams method returns as a result an object with the following properties:

IO.BBG.IB_Chat.SubscribeToStream

Subscribes to a stream to receive real-time messages. The Instant Bloomberg Adapter uses the peerId and application properties of the subscriber to manage per-subscriber state.

The IO.BBG.IB_Chat.SubscribeToStream method accepts as an argument an object with the following properties:

The IO.BBG.IB_Chat.SubscribeToStream method returns { success: true } on success or { error } on failure.

IO.BBG.IB_Chat.UnsubscribeFromStream

Unsubscribes from a previously subscribed stream.

The IO.BBG.IB_Chat.UnsubscribeFromStream method accepts as an argument an object with the following properties:

The IO.BBG.IB_Chat.UnsubscribeFromStream method returns { success: true } on success or { error } on failure.

Methods for initiating conversations and receiving messages.

IO.BBG.IB_Chat.NewChat

Initiates a new IB Chat conversation. Supports two input modes — a full payload object or flat properties. If both are provided, the payload object takes precedence.

The IO.BBG.IB_Chat.NewChat method accepts as an argument an object with the following properties:

The "payload" object has the following properties:

The "chatMessage" object has the following properties:

The "sender" object has the following properties:

The "table" object has the following properties:

Each object in the "recipients" array has the following properties:

The IO.BBG.IB_Chat.NewChat method returns as a result an object with the following properties:

IO.BBG.IB_Chat.ReceivedMessage

This isn't a method registered by the Instant Bloomberg Adapter — it's the default Interop method name that the Instant Bloomberg Adapter uses to forward stream events to subscribed apps via io.interop.invoke(). The method name is configurable per subscriber via the onMessageApiName property in IO.BBG.IB_Chat.SubscribeToStream.

To receive messages, register a method with the expected name:

await io.interop.register("IO.BBG.IB_Chat.ReceivedMessage", (args) => {
    console.log(args);
});

Each forwarded message contains the following properties:

Methods for posting, replying with, and retracting idea suggestions.

IO.BBG.IB_Chat.PostUnsolicitedIdea

Posts an unsolicited idea (UIDEA) to a stream. Unlike IO.BBG.IB_Chat.ReplyWithIdea, no eventCorrelationId is needed. Requires at least one recipient and one suggestion.

The IO.BBG.IB_Chat.PostUnsolicitedIdea method accepts as an argument an object with the following properties:

The "payload" object has the following properties:

The "confirmButton", "declineButton", and "customActionButtons" items are objects with the following properties:

The "ideaHeaderProperties" object has the following properties:

The "destinations" object has the following properties:

Each object in the "destinationIds" array has the following properties:

Each object in the "recipients" array has the following properties:

Each object in the "roomIds" array has the following properties:

Each object in the "suggestions" array has the following properties:

IO.BBG.IB_Chat.ReplyWithIdea

Replies to a stream event with an IDEA suggestion. Supports two input modes — a full payload object or flat properties. If both are provided, the payload object takes precedence.

The IO.BBG.IB_Chat.ReplyWithIdea method accepts as an argument an object with the following properties:

The "payload" object has the following properties:

The "confirmButton", "declineButton", and "customActionButtons" items are objects with the following properties:

The "ideaHeaderProperties" object has the following properties:

Each object in the "recipients" array has the following properties:

Each object in the "suggestions" array has the following properties:

IO.BBG.IB_Chat.RetractSuggestion

Retracts a previously posted suggestion. Supports two input modes — a full payload object or flat properties. If both are provided, the payload object takes precedence.

The IO.BBG.IB_Chat.RetractSuggestion method accepts as an argument an object with the following properties:

The "payload" object has the following properties:

Each object in the "recipients" array has the following properties: