Event Predictions
event_predictionsRead-only
Return stored forecasts, consensus-style predictions, central-bank projections, survey forecasts, IMF forecasts, nowcasts, or FXMacroData blended predictions for macro announcements, for actual-vs-consensus, prior-vs-forecast, or event-surprise context. Rows are keyed by announcement_id/date/indicator and include prediction source metadata. Supported currencies: lowercase 3-letter catalogue currency, e.g. usd or eur. The indicator parameter lists the accepted indicator slugs. Access: API key required, else returns subscription_required with a subscribe link.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"currency": "<currency>",
"indicator": "<indicator>"
},
"name": "event_predictions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | One-based page number. When supplied, overrides offset. | |
| as_of | No | Historical publication cutoff with explicit timezone, or YYYY-MM-DD at UTC midnight. Later forecasts are excluded. | |
| basis | No | Real or nominal selector, matching the announcement series. | |
| limit | No | Maximum prediction groups to return. Defaults to 20; maximum 100. | |
| offset | No | Zero-based prediction-group offset. | |
| currency | Yes | 3-letter ISO currency code (case-insensitive). Supported: lowercase 3-letter catalogue currency, e.g. usd or eur. | |
| end_date | No | Optional inclusive upper bound by reference-period date, YYYY-MM-DD. | |
| frequency | No | Returned change basis selector, matching the announcement series. | |
| indicator | Yes | Required indicator slug. Currency-wide prediction reads are not supported. Supported: catalogue indicator slug, e.g. inflation or policy_rate. | |
| start_date | No | Optional inclusive lower bound by reference-period date, YYYY-MM-DD. | |
| before_date | No | Exclusive period-date cursor for event-linked groups; use the prior response's next_cursor. | |
| seasonality | No | Seasonal adjustment selector, matching the announcement series. | |
| annualization | No | Annualization selector, matching the announcement series. | |
| official_limit | No | Maximum native-period official forecasts; 0 omits this section. Inspect official_forecasts_truncated. | |
| prediction_type | No | Optional legacy forecast-type filter, kept for existing clients. Superseded by prediction_class: compiled_consensus, forecaster_survey, expectations_survey, market_implied, model_nowcast, central_bank_projection, institutional_projection or fxmacrodata. | |
| pre_release_only | No | Require event-linked forecasts to have been generated before the announcement. | |
| prediction_class | No | Forecast production class: compiled_consensus, forecaster_survey, expectations_survey, market_implied, model_nowcast, central_bank_projection, institutional_projection or fxmacrodata. | |
| prediction_source | No | Optional source slug filter, for example ecb_spf or philly_fed_spf. | |
| period_aggregation | No | Period aggregation selector, matching the announcement series. | |
| event_compatible_only | No | Restrict event-linked data to verified matching target periods, units and economic concepts. Native official_forecasts remain a separate section. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |