WSH metadata
get_wsh_metadataRead-only
Retrieve Wall Street Horizon event calendar metadata—event types and filter fields—to build get_wsh_events queries. Filter by text query and limit response length.
Instructions
Describe the Wall Street Horizon (WSH) event calendar: event types and filter fields.
Use it to build get_wsh_events queries: `event_types` lists the event type tags
(wshe_ed is the earnings date, for example) and `metadata_json` holds the full
description, filtered by `query` and cut at max_chars (default 30000, max 200000).
The metadata is fetched once and then served from this server's cache (`cached`).
Needs a Wall Street Horizon corporate event data subscription (paid) on the IBKR
login; without it IBKR answers with an ib_api_error. not_found means nothing matched
`query`.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Only return the parts of the metadata mentioning this text (case-insensitive), e.g. 'earnings' or 'wshe_ed'. Omit for everything. | |
| max_chars | No | Longest JSON to return, in characters (at most 200,000); longer JSON is cut and truncated is true. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | The filter applied to the metadata, if any. | |
| cached | Yes | True when served from this server's cache instead of a new request. | |
| truncated | No | True when the result was cut to the limit. | |
| fetched_at | Yes | When the metadata was fetched from IBKR (UTC). | |
| event_types | No | Event type tags (wshe_...) found in the returned metadata; pass them as event_types to get_wsh_events. | |
| total_chars | Yes | Length of the full (filtered) JSON before truncation. | |
| metadata_json | Yes | The metadata as compact JSON (only the parts mentioning query, when given). Not valid JSON when truncated is true. |