Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Browse, inspect, and validate the synthetic market worlds David provides.
GET /scenarios
scenario_id, then query its data.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | - | Filter by status (e.g. ready). |
path_mode | enum | No | - | historical_context | future_branch. |
min_ticker_count | integer | No | - | Only scenarios with at least this many tickers. |
max_scenario_day_count | integer | No | - | Only scenarios at most this many trading days. |
healthy_only | boolean | No | false | Only scenarios that passed validation. |
limit | integer | No | 20 | Page size (max 1000). |
offset | integer | No | 0 | Pagination offset. |
curl -s "https://api.davidhf.com/scenarios?path_mode=future_branch&healthy_only=true&limit=5" \
-H "X-API-KEY: YOUR_API_KEY"
dd.scenarios.list(path_mode="future_branch", healthy_only=True, limit=5)
{
"scenarios": [
{
"id": "81e62b3b-17bd-5f55-b9a4-5f36ae6392f3",
"status": "ready",
"scenario_type": "earnings_week",
"seed": 120001,
"name": "Contested election and policy volatility ...",
"start_date": "2026-09-24",
"end_date": "2030-08-05",
"current_date": "2026-09-24",
"generator_version": "synthetic-finance-generator-v0.1",
"calibration_version": "local-calibration-v0.1",
"public_summary": { "scenario_theme": "election_policy_volatility", "path_mode": "future_branch", "...": "..." }
}
]
}
dataset_split characteristics, path_mode, ticker count, and horizon to assemble train / validation / test / holdout sets from the curated library, no generation required.GET /scenarios/{scenario_id}
available_tickers.
curl -s "https://api.davidhf.com/scenarios/6724c7d1-1b34-5da4-bc69-5ab0ef99c3c0" \
-H "X-API-KEY: YOUR_API_KEY"
dd.scenarios.get("6724c7d1-1b34-5da4-bc69-5ab0ef99c3c0")
{
"scenario": {
"id": "6724c7d1-1b34-5da4-bc69-5ab0ef99c3c0",
"status": "ready",
"start_date": "1993-05-28",
"end_date": "2023-05-08",
"public_summary": {
"macro_regime": "inflation_shock",
"scenario_theme": "geopolitical_war_energy_shock",
"scenario_title": "War-driven energy shock: shipping-lane escalation ...",
"path_mode": "historical_context",
"market_description": "A regional war disrupts energy supply ...",
"agent_task": "Separate durable commodity winners from companies with temporary price spikes ...",
"market_mechanics": ["energy and materials gain on commodity pricing power", "..."]
},
"available_tickers": ["AAPL", "MSFT", "NVDA", "AMZN", "GOOGL", "..."]
}
}
GET /scenarios/{scenario_id}/validation
curl -s "https://api.davidhf.com/scenarios/6724c7d1-1b34-5da4-bc69-5ab0ef99c3c0/validation" \
-H "X-API-KEY: YOUR_API_KEY"
dd.scenarios.validation("6724c7d1-1b34-5da4-bc69-5ab0ef99c3c0")