Get raw regime series (synthetic replica or historical episode)
get_regime_dataUSE WHEN you want the raw price series behind a synthetic regime or a historical episode, to recompute a claim yourself. source='historical' + ref=<case_id> returns a real-market anchor episode (dates, closes; OHLCV with include_ohlcv) and the descriptors computed on it; source='synthetic' + ref=<profile_hint> [+ seed] returns one cached replica (closes, warmup_index) and its descriptors. An empty ref lists the available ids and sample seeds. Recompute the descriptors from the closes to verify any claim the platform made. Same data as the regime-data:// resources, for clients that cannot read resources.
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": {
"source": "<source>"
},
"name": "get_regime_data"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ref | No | historical: a case_id such as 'spy_lehman_2008'; synthetic: a profile_hint such as 'whipsaw_synthetic_spy'. Empty lists the available ids. | |
| seed | No | synthetic only: the replica seed (default: the lowest in the bundle; listed in the response as available_seeds). | |
| source | Yes | 'historical' (a real-market anchor episode) or 'synthetic' (one cached replica). | |
| include_ohlcv | No | Also return open/high/low/volume (about 5x larger); close alone is enough to recompute the descriptors. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |