mirror of
https://github.com/koala73/worldmonitor.git
synced 2026-04-26 01:24:59 +02:00
45f5e5a457
* feat(forecast): add AI Forecasts prediction module (Pro-tier)
MiroFish-inspired prediction engine that generates structured forecasts
across 6 domains (conflict, market, supply chain, political, military,
infrastructure) using existing WorldMonitor data streams.
- Proto definitions for ForecastService with GetForecasts RPC
- Dedicated seed script (seed-forecasts.mjs) with 6 domain detectors,
cross-domain cascade resolver, prediction market calibration, and
trend detection via prior snapshot comparison
- Premium-gated RPC handler (PREMIUM_RPC_PATHS enforcement)
- Lazy-loaded ForecastPanel with domain filters, probability bars,
trend arrows, signal evidence, and cascade links
- Health monitoring integration (seed-meta freshness tracking)
- Refresh scheduler with API key guard
* test(forecast): add 47 unit tests for forecast detectors and utilities
Covers forecastId, normalize, resolveCascades, calibrateWithMarkets,
computeTrends, and smoke tests for all 6 domain detectors. Exports
testable functions from seed script with direct-run guard.
* fix(forecast): domain mismatch 'infra' vs 'infrastructure', add panel category
- Seed script used 'infra' but ForecastPanel filtered on 'infrastructure',
causing Infra tab to show zero results
- Added 'forecast' to intelligence category in PANEL_CATEGORY_MAP
* fix(forecast): move CSS to one-time injection, improve type safety
- P2: Move style block from setContent to one-time document.head injection
to prevent CSS accumulation on repeated renders
- P3: Replace +toFixed(3) with Math.round for readability in seed script
- P3: Use Forecast type instead of any[] in RPC handler filter
* fix(forecast): handle sebuf proto data shapes from Redis
Detectors now normalize CII scores from server-side proto format
(combinedScore, TREND_DIRECTION_RISING, region) to uniform shape.
Outage severity handles proto enum format (SEVERITY_LEVEL_HIGH).
Added confidence floor of 0.3 for single-source predictions.
Verified against live Redis: 2 predictions generated (Iran infra
shutdown, IL political instability).
* feat(forecast): unlock AI Forecasts on web, lock desktop only (trial)
- Remove forecast RPC from PREMIUM_RPC_PATHS (web access is free)
- Panel locked on desktop only (same as oref-sirens/telegram-intel)
- Remove API key guards from data-loader and refresh scheduler
- Web users get full access during trial period
* chore: regenerate proto types with make generate
Re-ran make generate after rebasing on main. Plugin v0.7.0 dropped
@ts-nocheck from output, added it back to all 50 generated files.
Fixed 4 type errors from proto codegen changes:
- MarketSource enum -> string union type
- TemporalAnomalyProto -> TemporalAnomaly rename
- webcam lastUpdated number -> string
* fix(forecast): use chokepoints v4 key, include ciiContribution in unrest
- P1: Switch chokepoints input from stale v2 to active v4 Redis key,
matching bootstrap.js and cache-keys.ts
- P2: Add ciiContribution to unrest component fallback chain in
normalizeCiiEntry so political detector reads the correct sebuf field
* feat(forecast): Phase 2 LLM scenario enrichment + confidence model
MiroFish-inspired enhancements:
- LLM scenario narratives via Groq/OpenRouter (narrative-only, no numeric
adjustment). Evidence-grounded prompts with mandatory signal citation
and few-shot examples from MiroFish's SECTION_SYSTEM_PROMPT_TEMPLATE.
- Top-4 predictions batched into single LLM call for cost efficiency.
- News context from newsInsights attached to all predictions for LLM
prompt grounding (NOT in signals, cannot affect confidence).
- Deterministic confidence model: source diversity via SIGNAL_TO_SOURCE
mapping (deduplicates cii+cii_delta, theater+indicators) + calibration
agreement from prediction market drift. Floor 0.2, ceiling 1.0.
- Output validation: rejects scenarios without signal references.
- Truncated JSON repair for small model output.
- Structured JSON logging for LLM calls.
- Redis cache for LLM scenarios (1h TTL).
- 23 new tests (70 total), all passing.
- Live-tested: OpenRouter gemini-2.5-flash produces evidence-grounded
scenario narratives from real WorldMonitor data.
* feat(forecast): Phase 3 multi-perspective scenarios, projections, data-driven cascades
MiroFish-inspired enhancements:
- Multi-perspective LLM analysis: top-2 predictions get strategic,
regional, and contrarian viewpoints via combined LLM call
- Probability projections: domain-specific decay curves (h24/d7/d30)
anchored to timeHorizon so probability equals projections[timeHorizon]
- Data-driven cascade rules: moved from hardcoded array to JSON config
(scripts/data/cascade-rules.json) with schema validation, named
predicate evaluators, unknown key rejection, and fallback to defaults
- 4 new cascade paths: infrastructure->supply_chain, infrastructure->market
(both requiresSeverity:total), conflict->political, political->market
- Proto: added Perspectives and Projections messages to Forecast
- ForecastPanel: renders projections row and conditional perspectives toggle
- 89 tests (19 new), all passing
- Live-tested: OpenRouter produces perspectives from real data
* feat(forecast): Phase 4 data utilization + entity graph
Fixes data gaps that prevented 4 of 6 detectors from firing:
- Input normalizers: chokepoint v4 shape + GPS hexes-to-zones mapping
- Chokepoint warm-ping (production-only, requires WM_API_BASE_URL)
- Lowered CII conflict threshold from 70 to 60, gated on level=high|critical
4 new standalone detectors:
- UCDP conflict zones (10+ events per country)
- Cyber threat concentration (5+ threats per country)
- GPS jamming in maritime shipping zones (5 regions)
- Prediction markets as signals (60-90% probability markets)
Entity-relationship graph (file-based, 38 nodes):
- Countries, theaters, commodities, chokepoints, alliances
- Alias table resolves both ISO codes and display names
- Graph cascade discovery links predictions across entities
Result: 51 predictions (up from 1-2), spanning conflict, infrastructure,
and supply chain domains. 112 tests, all passing.
* fix(forecast): redis cache format, signal source mapping, type safety
Fresh-eyes audit fixes:
- BUG: redisSet used wrong Upstash API format (POST body with {value,ex}
instead of command array ['SET',key,value,'EX',ttl]). LLM cache writes
were silently failing, causing fresh LLM calls every run.
- BUG: prediction_market signal type missing from SIGNAL_TO_SOURCE,
inflating confidence for market-derived predictions.
- CLEANUP: Remove unnecessary (f as any) casts in ForecastPanel since
generated Forecast type already has projections/perspectives fields.
- CLEANUP: Bump health maxStaleMin from 60 to 90 to avoid false STALE
alerts when LLM calls add latency to seed runs.
* feat(forecast): headline-entity matching with news corroboration signals
Uses entity graph aliases to match headlines to predictions by
country/theater (excludes commodity/infrastructure nodes to prevent
false positives). Predictions with matching headlines get a
news_corroboration signal visible in the panel.
Also fixes buildUserPrompt to merge unique headlines from ALL
predictions in the LLM batch (was only reading preds[0].newsContext).
Live-tested: 13 of 51 predictions now have corroborating headlines
(Iran, Israel, Syria, Ukraine, etc). 116 tests, all passing.
* feat(forecast): add country-codes.json for headline-entity matching
56 countries with ISO codes, full names, and scoring keywords (extracted
from src/config/countries.ts + UCDP-relevant additions). Used by
attachNewsContext for richer headline matching via getSearchTermsForRegion
which combines country-codes + entity graph + keyword aliases.
14/57 predictions now have news corroboration (limited by headline
coverage, not matching quality: only 8 headlines currently available).
* feat(forecast): read 300 headlines from news digest instead of 8
Read news:digest:v1:full:en (300 headlines across 16 categories) instead
of just news:insights:v1 topStories (8 headlines). Fallback to topStories
if digest is unavailable.
Result: news corroboration jumped from 25% to 64% (38/59 predictions).
* fix(forecast): handle parenthetical country names in headline matching
Strip suffixes like '(Zaire)', '(Burma)', '(Soviet Union)' from UCDP
region names before matching against country-codes.json. Also use
includes() for reverse name lookup to catch partial matches.
Corroboration: 64% -> 69% (41/59). Remaining 18 unmatched are countries
with no current English-language news coverage.
* fix(forecast): cache validated LLM output, add digest test, log cache errors
Fresh-eyes audit fixes:
- Combined LLM cache now stores only validated items (was caching raw
unvalidated output, serving potentially invalid scenarios on cache hit)
- redisSet logs warnings on failure (was silently swallowing all errors)
- Added digest-based test for attachNewsContext (primary path was untested)
- Fixed test arity: attachNewsContext(preds, news, digest) with 3 params
* fix(forecast): remove dead confidenceFromSources, reduce warm-ping timeout
- P2: Remove confidenceFromSources (dead code, computeConfidence overwrites
all initial confidence values). Inline the formula in original detectors.
- P3: Reduce warm-ping timeout from 30s to 15s (non-critical step)
- P3: Add trial status comment on forecast panel config
* fix(forecast): resolve ISO codes to country names, fix market detector, safe pre-push
P1 fixes from code review:
- CII ISO codes (IL, IR) now resolved to full country names (Israel, Iran)
via country-codes.json. Prevents substring false positives (IL matching
Chile) in event correlation. Uses word-boundary regex for matching.
- Market detector CII-to-theater mapping now uses entity graph traversal
instead of broken theater-name substring matching. Iran correctly maps
to Middle East theater via graph links.
- Pre-push hook no longer runs destructive git checkout on proto freshness
failure. Reports mismatch and exits without modifying worktree.
889 lines
36 KiB
YAML
889 lines
36 KiB
YAML
openapi: 3.1.0
|
|
info:
|
|
title: EconomicService API
|
|
version: 1.0.0
|
|
paths:
|
|
/api/economic/v1/get-fred-series:
|
|
get:
|
|
tags:
|
|
- EconomicService
|
|
summary: GetFredSeries
|
|
description: GetFredSeries retrieves time series data from the Federal Reserve Economic Data.
|
|
operationId: GetFredSeries
|
|
parameters:
|
|
- name: series_id
|
|
in: query
|
|
description: FRED series ID (e.g., "GDP", "UNRATE", "CPIAUCSL").
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: limit
|
|
in: query
|
|
description: Maximum number of observations to return. Defaults to 120.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetFredSeriesResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/api/economic/v1/list-world-bank-indicators:
|
|
get:
|
|
tags:
|
|
- EconomicService
|
|
summary: ListWorldBankIndicators
|
|
description: ListWorldBankIndicators retrieves development indicator data from the World Bank.
|
|
operationId: ListWorldBankIndicators
|
|
parameters:
|
|
- name: indicator_code
|
|
in: query
|
|
description: World Bank indicator code (e.g., "NY.GDP.MKTP.CD").
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: country_code
|
|
in: query
|
|
description: Optional country filter (ISO 3166-1 alpha-2).
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: year
|
|
in: query
|
|
description: Optional year filter. Defaults to latest available.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
- name: page_size
|
|
in: query
|
|
description: Maximum items per page.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
- name: cursor
|
|
in: query
|
|
description: Cursor for next page.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListWorldBankIndicatorsResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/api/economic/v1/get-energy-prices:
|
|
get:
|
|
tags:
|
|
- EconomicService
|
|
summary: GetEnergyPrices
|
|
description: GetEnergyPrices retrieves current energy commodity prices from EIA.
|
|
operationId: GetEnergyPrices
|
|
parameters:
|
|
- name: commodities
|
|
in: query
|
|
description: Optional commodity filter. Empty returns all tracked commodities.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetEnergyPricesResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/api/economic/v1/get-macro-signals:
|
|
get:
|
|
tags:
|
|
- EconomicService
|
|
summary: GetMacroSignals
|
|
description: GetMacroSignals computes 7 macro signals from 6 upstream sources with BUY/CASH verdict.
|
|
operationId: GetMacroSignals
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetMacroSignalsResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/api/economic/v1/get-energy-capacity:
|
|
get:
|
|
tags:
|
|
- EconomicService
|
|
summary: GetEnergyCapacity
|
|
description: GetEnergyCapacity retrieves installed capacity data (solar, wind, coal) from EIA.
|
|
operationId: GetEnergyCapacity
|
|
parameters:
|
|
- name: energy_sources
|
|
in: query
|
|
description: |-
|
|
Energy source codes to query (e.g., "SUN", "WND", "COL").
|
|
Empty returns all tracked sources (SUN, WND, COL).
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: years
|
|
in: query
|
|
description: Number of years of historical data. Default 20 if not set.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetEnergyCapacityResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/api/economic/v1/get-bis-policy-rates:
|
|
get:
|
|
tags:
|
|
- EconomicService
|
|
summary: GetBisPolicyRates
|
|
description: GetBisPolicyRates retrieves central bank policy rates from BIS.
|
|
operationId: GetBisPolicyRates
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetBisPolicyRatesResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/api/economic/v1/get-bis-exchange-rates:
|
|
get:
|
|
tags:
|
|
- EconomicService
|
|
summary: GetBisExchangeRates
|
|
description: GetBisExchangeRates retrieves effective exchange rates from BIS.
|
|
operationId: GetBisExchangeRates
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetBisExchangeRatesResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/api/economic/v1/get-bis-credit:
|
|
get:
|
|
tags:
|
|
- EconomicService
|
|
summary: GetBisCredit
|
|
description: GetBisCredit retrieves credit-to-GDP ratio data from BIS.
|
|
operationId: GetBisCredit
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetBisCreditResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/api/economic/v1/get-fred-series-batch:
|
|
post:
|
|
tags:
|
|
- EconomicService
|
|
summary: GetFredSeriesBatch
|
|
description: GetFredSeriesBatch retrieves multiple FRED series in a single call.
|
|
operationId: GetFredSeriesBatch
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetFredSeriesBatchRequest'
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetFredSeriesBatchResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
components:
|
|
schemas:
|
|
Error:
|
|
type: object
|
|
properties:
|
|
message:
|
|
type: string
|
|
description: Error message (e.g., 'user not found', 'database connection failed')
|
|
description: Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.
|
|
FieldViolation:
|
|
type: object
|
|
properties:
|
|
field:
|
|
type: string
|
|
description: The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key')
|
|
description:
|
|
type: string
|
|
description: Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')
|
|
required:
|
|
- field
|
|
- description
|
|
description: FieldViolation describes a single validation error for a specific field.
|
|
ValidationError:
|
|
type: object
|
|
properties:
|
|
violations:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/FieldViolation'
|
|
description: List of validation violations
|
|
required:
|
|
- violations
|
|
description: ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.
|
|
GetFredSeriesRequest:
|
|
type: object
|
|
properties:
|
|
seriesId:
|
|
type: string
|
|
minLength: 1
|
|
description: FRED series ID (e.g., "GDP", "UNRATE", "CPIAUCSL").
|
|
limit:
|
|
type: integer
|
|
format: int32
|
|
description: Maximum number of observations to return. Defaults to 120.
|
|
required:
|
|
- seriesId
|
|
description: GetFredSeriesRequest specifies which FRED series to retrieve.
|
|
GetFredSeriesResponse:
|
|
type: object
|
|
properties:
|
|
series:
|
|
$ref: '#/components/schemas/FredSeries'
|
|
description: GetFredSeriesResponse contains the requested FRED series data.
|
|
FredSeries:
|
|
type: object
|
|
properties:
|
|
seriesId:
|
|
type: string
|
|
minLength: 1
|
|
description: Series identifier (e.g., "GDP", "UNRATE", "CPIAUCSL").
|
|
title:
|
|
type: string
|
|
description: Series title.
|
|
units:
|
|
type: string
|
|
description: Unit of measurement.
|
|
frequency:
|
|
type: string
|
|
description: Data frequency (e.g., "Monthly", "Quarterly").
|
|
observations:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/FredObservation'
|
|
required:
|
|
- seriesId
|
|
description: FredSeries represents a FRED time series with metadata.
|
|
FredObservation:
|
|
type: object
|
|
properties:
|
|
date:
|
|
type: string
|
|
description: Observation date as YYYY-MM-DD string.
|
|
value:
|
|
type: number
|
|
format: double
|
|
description: Observation value.
|
|
description: FredObservation represents a single data point from a FRED economic series.
|
|
ListWorldBankIndicatorsRequest:
|
|
type: object
|
|
properties:
|
|
indicatorCode:
|
|
type: string
|
|
minLength: 1
|
|
description: World Bank indicator code (e.g., "NY.GDP.MKTP.CD").
|
|
countryCode:
|
|
type: string
|
|
description: Optional country filter (ISO 3166-1 alpha-2).
|
|
year:
|
|
type: integer
|
|
format: int32
|
|
description: Optional year filter. Defaults to latest available.
|
|
pageSize:
|
|
type: integer
|
|
format: int32
|
|
description: Maximum items per page.
|
|
cursor:
|
|
type: string
|
|
description: Cursor for next page.
|
|
required:
|
|
- indicatorCode
|
|
description: ListWorldBankIndicatorsRequest specifies filters for retrieving World Bank data.
|
|
ListWorldBankIndicatorsResponse:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/WorldBankCountryData'
|
|
pagination:
|
|
$ref: '#/components/schemas/PaginationResponse'
|
|
description: ListWorldBankIndicatorsResponse contains World Bank indicator data.
|
|
WorldBankCountryData:
|
|
type: object
|
|
properties:
|
|
countryCode:
|
|
type: string
|
|
minLength: 1
|
|
description: ISO 3166-1 alpha-2 country code.
|
|
countryName:
|
|
type: string
|
|
description: Country name.
|
|
indicatorCode:
|
|
type: string
|
|
minLength: 1
|
|
description: World Bank indicator code (e.g., "NY.GDP.MKTP.CD").
|
|
indicatorName:
|
|
type: string
|
|
description: Indicator name.
|
|
year:
|
|
type: integer
|
|
format: int32
|
|
description: Data year.
|
|
value:
|
|
type: number
|
|
format: double
|
|
description: Indicator value.
|
|
required:
|
|
- countryCode
|
|
- indicatorCode
|
|
description: WorldBankCountryData represents a World Bank indicator value for a country.
|
|
PaginationResponse:
|
|
type: object
|
|
properties:
|
|
nextCursor:
|
|
type: string
|
|
description: Cursor for fetching the next page. Empty string indicates no more pages.
|
|
totalCount:
|
|
type: integer
|
|
format: int32
|
|
description: Total count of items matching the query, if known. Zero if the total is unknown.
|
|
description: PaginationResponse contains pagination metadata returned alongside list results.
|
|
GetEnergyPricesRequest:
|
|
type: object
|
|
properties:
|
|
commodities:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Optional commodity filter. Empty returns all tracked commodities.
|
|
description: GetEnergyPricesRequest specifies which energy commodities to retrieve.
|
|
GetEnergyPricesResponse:
|
|
type: object
|
|
properties:
|
|
prices:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/EnergyPrice'
|
|
description: GetEnergyPricesResponse contains energy price data.
|
|
EnergyPrice:
|
|
type: object
|
|
properties:
|
|
commodity:
|
|
type: string
|
|
minLength: 1
|
|
description: Energy commodity identifier.
|
|
name:
|
|
type: string
|
|
description: Human-readable name (e.g., "WTI Crude Oil", "Henry Hub Natural Gas").
|
|
price:
|
|
type: number
|
|
format: double
|
|
description: Current price in USD.
|
|
unit:
|
|
type: string
|
|
description: Unit of measurement (e.g., "$/barrel", "$/MMBtu").
|
|
change:
|
|
type: number
|
|
format: double
|
|
description: Percentage change from previous period.
|
|
priceAt:
|
|
type: integer
|
|
format: int64
|
|
description: 'Price date, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
|
|
required:
|
|
- commodity
|
|
description: EnergyPrice represents a current energy commodity price from EIA.
|
|
GetMacroSignalsRequest:
|
|
type: object
|
|
description: GetMacroSignalsRequest requests the current macro signal dashboard.
|
|
GetMacroSignalsResponse:
|
|
type: object
|
|
properties:
|
|
timestamp:
|
|
type: string
|
|
description: ISO 8601 timestamp of computation.
|
|
verdict:
|
|
type: string
|
|
description: 'Overall verdict: "BUY", "CASH", or "UNKNOWN".'
|
|
bullishCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of bullish signals.
|
|
totalCount:
|
|
type: integer
|
|
format: int32
|
|
description: Total number of evaluated signals (excluding UNKNOWN).
|
|
signals:
|
|
$ref: '#/components/schemas/MacroSignals'
|
|
meta:
|
|
$ref: '#/components/schemas/MacroMeta'
|
|
unavailable:
|
|
type: boolean
|
|
description: True when upstream data is unavailable (fallback result).
|
|
description: GetMacroSignalsResponse contains the full macro signal dashboard with 7 signals and verdict.
|
|
MacroSignals:
|
|
type: object
|
|
properties:
|
|
liquidity:
|
|
$ref: '#/components/schemas/LiquiditySignal'
|
|
flowStructure:
|
|
$ref: '#/components/schemas/FlowStructureSignal'
|
|
macroRegime:
|
|
$ref: '#/components/schemas/MacroRegimeSignal'
|
|
technicalTrend:
|
|
$ref: '#/components/schemas/TechnicalTrendSignal'
|
|
hashRate:
|
|
$ref: '#/components/schemas/HashRateSignal'
|
|
priceMomentum:
|
|
$ref: '#/components/schemas/PriceMomentumSignal'
|
|
fearGreed:
|
|
$ref: '#/components/schemas/FearGreedSignal'
|
|
description: MacroSignals contains all 7 individual signal computations.
|
|
LiquiditySignal:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: '"SQUEEZE", "NORMAL", or "UNKNOWN".'
|
|
value:
|
|
type: number
|
|
format: double
|
|
description: JPY 30d ROC percentage, absent if unavailable.
|
|
sparkline:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: double
|
|
description: Last 30 JPY close prices.
|
|
description: LiquiditySignal tracks JPY 30d rate of change as a liquidity proxy.
|
|
FlowStructureSignal:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: '"PASSIVE GAP", "ALIGNED", or "UNKNOWN".'
|
|
btcReturn5:
|
|
type: number
|
|
format: double
|
|
description: BTC 5-day return percentage.
|
|
qqqReturn5:
|
|
type: number
|
|
format: double
|
|
description: QQQ 5-day return percentage.
|
|
description: FlowStructureSignal compares BTC vs QQQ 5-day returns.
|
|
MacroRegimeSignal:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: '"RISK-ON", "DEFENSIVE", or "UNKNOWN".'
|
|
qqqRoc20:
|
|
type: number
|
|
format: double
|
|
description: QQQ 20d ROC percentage.
|
|
xlpRoc20:
|
|
type: number
|
|
format: double
|
|
description: XLP 20d ROC percentage.
|
|
description: MacroRegimeSignal compares QQQ vs XLP 20-day rate of change.
|
|
TechnicalTrendSignal:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: '"BULLISH", "BEARISH", "NEUTRAL", or "UNKNOWN".'
|
|
btcPrice:
|
|
type: number
|
|
format: double
|
|
description: Current BTC price.
|
|
sma50:
|
|
type: number
|
|
format: double
|
|
description: 50-day simple moving average.
|
|
sma200:
|
|
type: number
|
|
format: double
|
|
description: 200-day simple moving average.
|
|
vwap30d:
|
|
type: number
|
|
format: double
|
|
description: 30-day volume-weighted average price.
|
|
mayerMultiple:
|
|
type: number
|
|
format: double
|
|
description: Mayer multiple (BTC price / SMA200).
|
|
sparkline:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: double
|
|
description: Last 30 BTC close prices.
|
|
description: TechnicalTrendSignal evaluates BTC price vs moving averages and VWAP.
|
|
HashRateSignal:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: '"GROWING", "DECLINING", "STABLE", or "UNKNOWN".'
|
|
change30d:
|
|
type: number
|
|
format: double
|
|
description: Hash rate change over 30 days as percentage.
|
|
description: HashRateSignal tracks Bitcoin hash rate momentum.
|
|
PriceMomentumSignal:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: '"STRONG", "MODERATE", "WEAK", or "UNKNOWN".'
|
|
description: PriceMomentumSignal uses the Mayer Multiple (price/SMA200) as a market-adaptive signal.
|
|
FearGreedSignal:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: Classification label (e.g., "Extreme Fear", "Greed").
|
|
value:
|
|
type: integer
|
|
format: int32
|
|
description: Current index value (0-100).
|
|
history:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/FearGreedHistoryEntry'
|
|
description: FearGreedSignal tracks the Crypto Fear & Greed index.
|
|
FearGreedHistoryEntry:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: integer
|
|
maximum: 100
|
|
minimum: 0
|
|
format: int32
|
|
description: Index value (0-100).
|
|
date:
|
|
type: string
|
|
description: Date string (YYYY-MM-DD).
|
|
description: FearGreedHistoryEntry is a single day's Fear & Greed index reading.
|
|
MacroMeta:
|
|
type: object
|
|
properties:
|
|
qqqSparkline:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: double
|
|
description: Last 30 QQQ close prices for sparkline.
|
|
description: MacroMeta contains supplementary chart data.
|
|
GetEnergyCapacityRequest:
|
|
type: object
|
|
properties:
|
|
energySources:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: |-
|
|
Energy source codes to query (e.g., "SUN", "WND", "COL").
|
|
Empty returns all tracked sources (SUN, WND, COL).
|
|
years:
|
|
type: integer
|
|
format: int32
|
|
description: Number of years of historical data. Default 20 if not set.
|
|
GetEnergyCapacityResponse:
|
|
type: object
|
|
properties:
|
|
series:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/EnergyCapacitySeries'
|
|
EnergyCapacitySeries:
|
|
type: object
|
|
properties:
|
|
energySource:
|
|
type: string
|
|
name:
|
|
type: string
|
|
data:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/EnergyCapacityYear'
|
|
EnergyCapacityYear:
|
|
type: object
|
|
properties:
|
|
year:
|
|
type: integer
|
|
format: int32
|
|
capacityMw:
|
|
type: number
|
|
format: double
|
|
GetBisPolicyRatesRequest:
|
|
type: object
|
|
description: GetBisPolicyRatesRequest requests central bank policy rates.
|
|
GetBisPolicyRatesResponse:
|
|
type: object
|
|
properties:
|
|
rates:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/BisPolicyRate'
|
|
description: GetBisPolicyRatesResponse contains BIS policy rate data.
|
|
BisPolicyRate:
|
|
type: object
|
|
properties:
|
|
countryCode:
|
|
type: string
|
|
description: ISO 2-letter country code (US, GB, JP, etc.)
|
|
countryName:
|
|
type: string
|
|
description: Country or region name.
|
|
rate:
|
|
type: number
|
|
format: double
|
|
description: Current policy rate percentage.
|
|
previousRate:
|
|
type: number
|
|
format: double
|
|
description: Previous period rate percentage.
|
|
date:
|
|
type: string
|
|
description: Date as YYYY-MM.
|
|
centralBank:
|
|
type: string
|
|
description: Central bank name (e.g. "Federal Reserve").
|
|
description: BisPolicyRate represents a central bank policy rate from BIS.
|
|
GetBisExchangeRatesRequest:
|
|
type: object
|
|
description: GetBisExchangeRatesRequest requests effective exchange rates.
|
|
GetBisExchangeRatesResponse:
|
|
type: object
|
|
properties:
|
|
rates:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/BisExchangeRate'
|
|
description: GetBisExchangeRatesResponse contains BIS effective exchange rate data.
|
|
BisExchangeRate:
|
|
type: object
|
|
properties:
|
|
countryCode:
|
|
type: string
|
|
description: ISO 2-letter country code.
|
|
countryName:
|
|
type: string
|
|
description: Country or region name.
|
|
realEer:
|
|
type: number
|
|
format: double
|
|
description: Real effective exchange rate index.
|
|
nominalEer:
|
|
type: number
|
|
format: double
|
|
description: Nominal effective exchange rate index.
|
|
realChange:
|
|
type: number
|
|
format: double
|
|
description: Percentage change from previous period (real).
|
|
date:
|
|
type: string
|
|
description: Date as YYYY-MM.
|
|
description: BisExchangeRate represents effective exchange rate indices from BIS.
|
|
GetBisCreditRequest:
|
|
type: object
|
|
description: GetBisCreditRequest requests credit-to-GDP ratio data.
|
|
GetBisCreditResponse:
|
|
type: object
|
|
properties:
|
|
entries:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/BisCreditToGdp'
|
|
description: GetBisCreditResponse contains BIS credit-to-GDP data.
|
|
BisCreditToGdp:
|
|
type: object
|
|
properties:
|
|
countryCode:
|
|
type: string
|
|
description: ISO 2-letter country code.
|
|
countryName:
|
|
type: string
|
|
description: Country or region name.
|
|
creditGdpRatio:
|
|
type: number
|
|
format: double
|
|
description: Total credit as percentage of GDP.
|
|
previousRatio:
|
|
type: number
|
|
format: double
|
|
description: Previous quarter ratio.
|
|
date:
|
|
type: string
|
|
description: Date as YYYY-QN.
|
|
description: BisCreditToGdp represents total credit as percentage of GDP from BIS.
|
|
GetFredSeriesBatchRequest:
|
|
type: object
|
|
properties:
|
|
seriesIds:
|
|
type: array
|
|
items:
|
|
type: string
|
|
maxItems: 10
|
|
minItems: 1
|
|
description: FRED series IDs (e.g., "WALCL", "FEDFUNDS"). Max 10.
|
|
maxItems: 10
|
|
minItems: 1
|
|
limit:
|
|
type: integer
|
|
format: int32
|
|
description: Maximum number of observations per series. Defaults to 120.
|
|
description: GetFredSeriesBatchRequest looks up multiple FRED series in a single call.
|
|
GetFredSeriesBatchResponse:
|
|
type: object
|
|
properties:
|
|
results:
|
|
type: object
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/FredSeries'
|
|
description: Map of series_id -> FRED series for found series.
|
|
fetched:
|
|
type: integer
|
|
format: int32
|
|
description: Number of series successfully fetched.
|
|
requested:
|
|
type: integer
|
|
format: int32
|
|
description: Number of series requested.
|
|
description: GetFredSeriesBatchResponse contains the requested FRED series data.
|
|
ResultsEntry:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
$ref: '#/components/schemas/FredSeries'
|