Read subscription
get_subscription_dataRead-only
Fetch the latest data from an active subscription—quotes, order book, ticks, bars, scanner rows, or news—with optional limit and since-time filtering for incremental reads.
Instructions
Read the latest state of any subscription: quote, order book, ticks, bars, rows, news...
`data` depends on `kind`: quotes → `quote` (+ `extras`); depth → `bids`/`asks`;
tick_by_tick → `ticks`; realtime_bars and bars → `bars`; scanner → `rows`; news →
`headlines`; news_bulletins → `bulletins`; display_group → `current` and `updates`.
Time series (ticks, bars, headlines, bulletins, display group updates) come oldest
first, cut to the newest `limit` (default 100, max 5000) after `since`;
`data.truncated` is true when older ones were left out.
Stream snapshots also carry `active`, `error` and `notices` (IBKR messages such as
delayed data or a lost subscription). `stale` true means the gateway connection
dropped and values may be old. Each read keeps the subscription alive; one not read
for its idle time is cancelled and this tool then reports subscription_not_found.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of items to return. Omit for the tool's default; larger values are capped. The result's truncated flag says whether more were available. | |
| since | No | Only items (ticks, bars, headlines, bulletins, display group updates) after this time (ISO 8601, UTC if no zone). Pass the time of the last item you read to get only new ones. | |
| subscription_id | Yes | The id a subscribe_* tool returned (see list_subscriptions). |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | The snapshot; its fields depend on kind. | |
| kind | Yes | ||
| stale | No | True when the values may be old; see get_health. | |
| created_at | Yes | ||
| last_read_at | No | The previous read, before this one (UTC). | |
| subscription_id | Yes |