Stream IBKR bulletins
subscribe_news_bulletinsSubscribe to receive IBKR system bulletins about exchange availability. Get notices when an exchange becomes unavailable or available, with a handle to read each bulletin.
Instructions
Stream IBKR's system bulletins: notices and exchanges becoming unavailable or available.
Returns a handle; read the bulletins with get_subscription_data(subscription_id)
(each has type news, exchange_unavailable or exchange_available, the message and the
exchange). There is one bulletin stream per gateway connection, so calling this
again returns the same handle, and all_messages only counts the first time. Stop it
with unsubscribe; it is cancelled after idle_ttl_s seconds without a read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| all_messages | No | Also send the bulletins already issued today, not only new ones. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | What it streams for: the contract id plus parameters. | |
| kind | Yes | What streams: quotes, depth, tick_by_tick, realtime_bars, bars, scanner, news_bulletins, news or display_group. | |
| contract | No | The instrument, when there is one. | |
| created_at | Yes | ||
| idle_ttl_s | Yes | Seconds without a read before it is cancelled. | |
| deduplicated | No | True when an identical stream was already open and its handle was returned instead of opening a second one. | |
| subscription_id | Yes | Handle for get_subscription_data and unsubscribe. |