GET /api/lead-lag
Requires Bearer token.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
cause | string | ✓ | Leading signal group (e.g. businessVitality, populationMomentum). | |
effect | string | ✓ | Lagging signal group (e.g. developmentPipeline, economicStrength). | |
metro | string | Metro slug filter. Omit for all metros. | ||
lag_months | int | 12 | Maximum lag window in months (1-24). |
| Field | Type | Description |
|---|---|---|
peak_lag_months | int | Month offset where correlation is strongest. |
peak_correlation | float | Pearson correlation at peak lag (0-1). |
survival_curve | array | Monthly correlation values over the lag window. |
interpretation | string | Human-readable summary of the lead-lag relationship. |
GET /api/permits/predict
Requires Bearer token.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
h3_index | string | ✓ | H3 hex index at resolution 8. | |
horizon | int | 6 | Forecast horizon in months (1-12). |
| Field | Type | Description |
|---|---|---|
historical_avg_monthly | float | Average monthly permits over the last 12 months. |
forecast | array | Monthly predictions with confidence intervals. |
forecast[].predicted_permits | int | Predicted permit count for the month. |
forecast[].confidence | float | Model confidence (0-1), decreases with horizon. |
trend | string | Overall trend direction: increasing, stable, or decreasing. |