mirror of
https://github.com/koala73/worldmonitor.git
synced 2026-04-25 17:14:57 +02:00
7013b2f9f1
* Add Fear & Greed Index 2.0 reverse engineering brief Analyzes the 10-category weighted composite (Sentiment, Volatility, Positioning, Trend, Breadth, Momentum, Liquidity, Credit, Macro, Cross-Asset) with scoring formulas, data source audit, and implementation plan for building it as a worldmonitor panel. https://claude.ai/code/session_01HR69u6oF1VCMwsC2PHFL8i * Add seed script implementation plan to F&G brief Details exact endpoints, Yahoo symbols (17 calls), Redis key schema, computed metrics, FRED series to add (BAMLC0A0CM, SOFR), CNN/AAII sources, output JSON schema, and estimated runtime (~8s per seed run). https://claude.ai/code/session_01HR69u6oF1VCMwsC2PHFL8i * Update brief: all sources are free, zero paid APIs needed - CBOE CDN CSVs for put/call ratios (totalpc.csv, equitypc.csv) - CNN dataviz API for Fear & Greed (production.dataviz.cnn.io) - Yahoo Finance for VIX9D/VIX3M/SKEW/RSP/NYA (standard symbols) - FRED for IG spread (BAMLC0A0CM) and SOFR (add to existing array) - AAII scrape for bull/bear survey (only medium-effort source) - Breadth via RSP/SPY divergence + NYSE composite (no scraping) https://claude.ai/code/session_01HR69u6oF1VCMwsC2PHFL8i * Add verified Yahoo symbols for breadth + finalized source list New discoveries: - ^MMTH = % stocks above 200 DMA (direct Yahoo symbol!) - C:ISSU = NYSE advance/decline data - CNN endpoint accepts date param for historical data - CBOE CSVs have data back to 2003 - 33 total calls per seed run, ~6s runtime All 10 categories now have confirmed free sources. https://claude.ai/code/session_01HR69u6oF1VCMwsC2PHFL8i * Rewrite F&G brief as forward-looking design doc Remove all reverse-engineering language, screenshot references, and discovery notes. Clean structure: goal, scoring model, data sources, formulas, seed script plan, implementation phases, MVP path. https://claude.ai/code/session_01HR69u6oF1VCMwsC2PHFL8i * docs: apply gold standard corrections to fear-greed-index-2.0 brief * feat(market): add Fear & Greed Index 2.0 — 10-category composite sentiment panel Composite 0-100 index from 10 weighted categories: sentiment (CNN F&G, AAII, crypto F&G), volatility (VIX, term structure), positioning (P/C ratio, SKEW), trend (SPX vs MAs), breadth (% >200d, RSP/SPY divergence), momentum (sector RSI, ROC), liquidity (M2, Fed BS, SOFR), credit (HY/IG spreads), macro (Fed rate, yield curve, unemployment), cross-asset (gold/bonds/DXY vs equities). Data layer: - seed-fear-greed.mjs: 19 Yahoo symbols (150ms gaps), CBOE P/C CSVs, CNN F&G API, AAII scrape (degraded-safe), FRED Redis reads. TTL 64800s. - seed-economy.mjs: add BAMLC0A0CM (IG spread) and SOFR to FRED_SERIES. - Bootstrap 4-file checklist: cache-keys, bootstrap.js, health.js, handler. Proto + RPC: - get_fear_greed_index.proto with FearGreedCategory message. - get-fear-greed-index.ts handler reads seeded Redis data. Frontend: - FearGreedPanel with gauge, 9-metric header grid, 10-category breakdown. - Self-loading via bootstrap hydration + RPC fallback. - Registered in panel-layout, App.ts (prime + refresh), panel config, Cmd-K commands, finance variant, i18n (en/ar/zh/es). * fix(market): add RPC_CACHE_TIER entry for get-fear-greed-index * fix(docs): escape bare angle bracket in fear-greed brief for MDX * fix(docs): fix markdown lint errors in fear-greed brief (blank lines around headings/lists) * fix(market): fix seed-fear-greed bugs from code review - fredLatest/fredNMonthsAgo: guard parseFloat with Number.isFinite to handle FRED's "." missing-data sentinel (was returning NaN which propagated through scoring as a truthy non-null value) - Remove 3 unused Yahoo symbols (^NYA, HYG, LQD) that were fetched but not referenced in any scoring category (saves ~450ms per run) - fedRateStr: display effective rate directly instead of deriving target range via (fedRate - 0.25) which was incorrect * fix(market): address P2/P3 review findings in Fear & Greed - FearGreedPanel: add mapSeedPayload() to correctly map raw seed JSON to proto-shaped FearGreedData; bootstrap hydration was always falling through to RPC because seed shape (composite.score) differs from proto shape (compositeScore) - FearGreedPanel: fix fmt() — remove === 0 guard and add explicit > 0 checks on VIX and P/C Ratio display to handle proto default zeros without masking genuine zero values (e.g. pctAbove200d) - seed-fear-greed: remove broken history write — each run overwrote the key with a single-entry array (no read-then-append), making the 90-day TTL meaningless; no consumer exists yet so defer to later - seed-fear-greed: extract hySpreadVal const to avoid double fredLatest call - seed-fear-greed: fix stale comment (19 symbols → 16 after prior cleanup) --------- Co-authored-by: Claude <noreply@anthropic.com>
1464 lines
55 KiB
YAML
1464 lines
55 KiB
YAML
openapi: 3.1.0
|
|
info:
|
|
title: MarketService API
|
|
version: 1.0.0
|
|
paths:
|
|
/api/market/v1/list-market-quotes:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListMarketQuotes
|
|
description: ListMarketQuotes retrieves stock and index quotes.
|
|
operationId: ListMarketQuotes
|
|
parameters:
|
|
- name: symbols
|
|
in: query
|
|
description: Ticker symbols to retrieve (e.g., ["AAPL", "^GSPC"]). Empty returns defaults.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListMarketQuotesResponse'
|
|
"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/market/v1/list-crypto-quotes:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListCryptoQuotes
|
|
description: ListCryptoQuotes retrieves cryptocurrency quotes from CoinGecko.
|
|
operationId: ListCryptoQuotes
|
|
parameters:
|
|
- name: ids
|
|
in: query
|
|
description: Cryptocurrency IDs to retrieve (CoinGecko IDs). Empty returns defaults.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListCryptoQuotesResponse'
|
|
"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/market/v1/list-commodity-quotes:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListCommodityQuotes
|
|
description: ListCommodityQuotes retrieves commodity price quotes from Yahoo Finance.
|
|
operationId: ListCommodityQuotes
|
|
parameters:
|
|
- name: symbols
|
|
in: query
|
|
description: Commodity symbols to retrieve (Yahoo symbols). Empty returns defaults.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListCommodityQuotesResponse'
|
|
"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/market/v1/get-sector-summary:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: GetSectorSummary
|
|
description: GetSectorSummary retrieves market sector performance data from Finnhub.
|
|
operationId: GetSectorSummary
|
|
parameters:
|
|
- name: period
|
|
in: query
|
|
description: Time period for performance calculation (e.g., "1d", "1w", "1m"). Defaults to "1d".
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetSectorSummaryResponse'
|
|
"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/market/v1/list-stablecoin-markets:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListStablecoinMarkets
|
|
description: ListStablecoinMarkets retrieves stablecoin peg health and market data from CoinGecko.
|
|
operationId: ListStablecoinMarkets
|
|
parameters:
|
|
- name: coins
|
|
in: query
|
|
description: CoinGecko IDs to retrieve (e.g. "tether,usd-coin"). Empty returns defaults.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListStablecoinMarketsResponse'
|
|
"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/market/v1/list-etf-flows:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListEtfFlows
|
|
description: ListEtfFlows retrieves BTC spot ETF flow estimates from Yahoo Finance.
|
|
operationId: ListEtfFlows
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListEtfFlowsResponse'
|
|
"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/market/v1/get-country-stock-index:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: GetCountryStockIndex
|
|
description: GetCountryStockIndex retrieves the primary stock index for a country from Yahoo Finance.
|
|
operationId: GetCountryStockIndex
|
|
parameters:
|
|
- name: country_code
|
|
in: query
|
|
description: ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "JP").
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetCountryStockIndexResponse'
|
|
"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/market/v1/list-gulf-quotes:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListGulfQuotes
|
|
description: ListGulfQuotes retrieves Gulf region market quotes (indices, currencies, oil).
|
|
operationId: ListGulfQuotes
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListGulfQuotesResponse'
|
|
"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/market/v1/analyze-stock:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: AnalyzeStock
|
|
description: AnalyzeStock retrieves a premium stock analysis report with technicals, news, and AI synthesis.
|
|
operationId: AnalyzeStock
|
|
parameters:
|
|
- name: symbol
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: name
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: include_news
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AnalyzeStockResponse'
|
|
"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/market/v1/get-stock-analysis-history:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: GetStockAnalysisHistory
|
|
description: GetStockAnalysisHistory retrieves shared premium stock analysis history from the backend store.
|
|
operationId: GetStockAnalysisHistory
|
|
parameters:
|
|
- name: symbols
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: limit_per_symbol
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
- name: include_news
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetStockAnalysisHistoryResponse'
|
|
"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/market/v1/backtest-stock:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: BacktestStock
|
|
description: BacktestStock replays premium stock-analysis signals over recent price history.
|
|
operationId: BacktestStock
|
|
parameters:
|
|
- name: symbol
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: name
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: eval_window_days
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/BacktestStockResponse'
|
|
"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/market/v1/list-stored-stock-backtests:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListStoredStockBacktests
|
|
description: ListStoredStockBacktests retrieves stored premium backtest snapshots from the backend store.
|
|
operationId: ListStoredStockBacktests
|
|
parameters:
|
|
- name: symbols
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: eval_window_days
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListStoredStockBacktestsResponse'
|
|
"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/market/v1/list-crypto-sectors:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListCryptoSectors
|
|
description: ListCryptoSectors retrieves crypto sector performance averages.
|
|
operationId: ListCryptoSectors
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListCryptoSectorsResponse'
|
|
"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/market/v1/list-defi-tokens:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListDefiTokens
|
|
description: ListDefiTokens retrieves DeFi token prices and changes.
|
|
operationId: ListDefiTokens
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListDefiTokensResponse'
|
|
"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/market/v1/list-ai-tokens:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListAiTokens
|
|
description: ListAiTokens retrieves AI-focused crypto token prices and changes.
|
|
operationId: ListAiTokens
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListAiTokensResponse'
|
|
"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/market/v1/list-other-tokens:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: ListOtherTokens
|
|
description: ListOtherTokens retrieves other/trending crypto token prices and changes.
|
|
operationId: ListOtherTokens
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListOtherTokensResponse'
|
|
"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/market/v1/get-fear-greed-index:
|
|
get:
|
|
tags:
|
|
- MarketService
|
|
summary: GetFearGreedIndex
|
|
description: GetFearGreedIndex retrieves the composite Fear & Greed sentiment index.
|
|
operationId: GetFearGreedIndex
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GetFearGreedIndexResponse'
|
|
"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.
|
|
ListMarketQuotesRequest:
|
|
type: object
|
|
properties:
|
|
symbols:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Ticker symbols to retrieve (e.g., ["AAPL", "^GSPC"]). Empty returns defaults.
|
|
description: ListMarketQuotesRequest specifies which stock/index symbols to retrieve.
|
|
ListMarketQuotesResponse:
|
|
type: object
|
|
properties:
|
|
quotes:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/MarketQuote'
|
|
finnhubSkipped:
|
|
type: boolean
|
|
description: True when the Finnhub API key is not configured and stock quotes were skipped.
|
|
skipReason:
|
|
type: string
|
|
description: Human-readable reason when Finnhub was skipped (e.g., "FINNHUB_API_KEY not configured").
|
|
rateLimited:
|
|
type: boolean
|
|
description: True when the upstream API rate-limited the request.
|
|
description: ListMarketQuotesResponse contains stock and index quotes.
|
|
MarketQuote:
|
|
type: object
|
|
properties:
|
|
symbol:
|
|
type: string
|
|
minLength: 1
|
|
description: Ticker symbol (e.g., "AAPL", "^GSPC").
|
|
name:
|
|
type: string
|
|
description: Human-readable name.
|
|
display:
|
|
type: string
|
|
description: Display label.
|
|
price:
|
|
type: number
|
|
format: double
|
|
description: Current price.
|
|
change:
|
|
type: number
|
|
format: double
|
|
description: Percentage change from previous close.
|
|
sparkline:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: double
|
|
description: Sparkline data points (recent price history).
|
|
required:
|
|
- symbol
|
|
description: MarketQuote represents a stock or index quote from Finnhub or Yahoo Finance.
|
|
ListCryptoQuotesRequest:
|
|
type: object
|
|
properties:
|
|
ids:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Cryptocurrency IDs to retrieve (CoinGecko IDs). Empty returns defaults.
|
|
description: ListCryptoQuotesRequest specifies which cryptocurrencies to retrieve.
|
|
ListCryptoQuotesResponse:
|
|
type: object
|
|
properties:
|
|
quotes:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CryptoQuote'
|
|
description: ListCryptoQuotesResponse contains cryptocurrency quotes.
|
|
CryptoQuote:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Cryptocurrency name (e.g., "Bitcoin").
|
|
symbol:
|
|
type: string
|
|
minLength: 1
|
|
description: Ticker symbol (e.g., "BTC").
|
|
price:
|
|
type: number
|
|
format: double
|
|
description: Current price in USD.
|
|
change:
|
|
type: number
|
|
format: double
|
|
description: 24-hour percentage change.
|
|
sparkline:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: double
|
|
description: Sparkline data points (recent price history).
|
|
change7d:
|
|
type: number
|
|
format: double
|
|
description: 7-day percentage change.
|
|
required:
|
|
- symbol
|
|
description: CryptoQuote represents a cryptocurrency quote from CoinGecko.
|
|
ListCommodityQuotesRequest:
|
|
type: object
|
|
properties:
|
|
symbols:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Commodity symbols to retrieve (Yahoo symbols). Empty returns defaults.
|
|
description: ListCommodityQuotesRequest specifies which commodities to retrieve.
|
|
ListCommodityQuotesResponse:
|
|
type: object
|
|
properties:
|
|
quotes:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CommodityQuote'
|
|
description: ListCommodityQuotesResponse contains commodity quotes.
|
|
CommodityQuote:
|
|
type: object
|
|
properties:
|
|
symbol:
|
|
type: string
|
|
minLength: 1
|
|
description: Commodity symbol (e.g., "CL=F" for crude oil).
|
|
name:
|
|
type: string
|
|
description: Human-readable name.
|
|
display:
|
|
type: string
|
|
description: Display label.
|
|
price:
|
|
type: number
|
|
format: double
|
|
description: Current price.
|
|
change:
|
|
type: number
|
|
format: double
|
|
description: Percentage change from previous close.
|
|
sparkline:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: double
|
|
description: Sparkline data points.
|
|
required:
|
|
- symbol
|
|
description: CommodityQuote represents a commodity price quote from Yahoo Finance.
|
|
GetSectorSummaryRequest:
|
|
type: object
|
|
properties:
|
|
period:
|
|
type: string
|
|
description: Time period for performance calculation (e.g., "1d", "1w", "1m"). Defaults to "1d".
|
|
description: GetSectorSummaryRequest specifies parameters for retrieving sector performance.
|
|
GetSectorSummaryResponse:
|
|
type: object
|
|
properties:
|
|
sectors:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/SectorPerformance'
|
|
description: GetSectorSummaryResponse contains sector performance data.
|
|
SectorPerformance:
|
|
type: object
|
|
properties:
|
|
symbol:
|
|
type: string
|
|
minLength: 1
|
|
description: Sector symbol.
|
|
name:
|
|
type: string
|
|
description: Sector name.
|
|
change:
|
|
type: number
|
|
format: double
|
|
description: Percentage change over the measured period.
|
|
required:
|
|
- symbol
|
|
description: SectorPerformance represents performance data for a market sector.
|
|
ListStablecoinMarketsRequest:
|
|
type: object
|
|
properties:
|
|
coins:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: CoinGecko IDs to retrieve (e.g. "tether,usd-coin"). Empty returns defaults.
|
|
description: ListStablecoinMarketsRequest specifies which stablecoins to retrieve.
|
|
ListStablecoinMarketsResponse:
|
|
type: object
|
|
properties:
|
|
timestamp:
|
|
type: string
|
|
description: Timestamp of the data fetch (ISO 8601).
|
|
summary:
|
|
$ref: '#/components/schemas/StablecoinSummary'
|
|
stablecoins:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Stablecoin'
|
|
description: ListStablecoinMarketsResponse contains stablecoin market data.
|
|
StablecoinSummary:
|
|
type: object
|
|
properties:
|
|
totalMarketCap:
|
|
type: number
|
|
format: double
|
|
description: Total market cap across all queried stablecoins.
|
|
totalVolume24h:
|
|
type: number
|
|
format: double
|
|
description: Total 24h volume across all queried stablecoins.
|
|
coinCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of stablecoins returned.
|
|
depeggedCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of stablecoins in DEPEGGED state.
|
|
healthStatus:
|
|
type: string
|
|
description: 'Overall health: "HEALTHY", "CAUTION", or "WARNING".'
|
|
description: StablecoinSummary contains aggregate stablecoin market stats.
|
|
Stablecoin:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
minLength: 1
|
|
description: CoinGecko ID.
|
|
symbol:
|
|
type: string
|
|
minLength: 1
|
|
description: Ticker symbol (e.g. "USDT").
|
|
name:
|
|
type: string
|
|
description: Human-readable name.
|
|
price:
|
|
type: number
|
|
minimum: 0
|
|
format: double
|
|
description: Current price in USD.
|
|
deviation:
|
|
type: number
|
|
format: double
|
|
description: Deviation from $1.00 peg, as a percentage.
|
|
pegStatus:
|
|
type: string
|
|
description: 'Peg status: "ON PEG", "SLIGHT DEPEG", or "DEPEGGED".'
|
|
marketCap:
|
|
type: number
|
|
format: double
|
|
description: Market capitalization in USD.
|
|
volume24h:
|
|
type: number
|
|
format: double
|
|
description: 24-hour trading volume in USD.
|
|
change24h:
|
|
type: number
|
|
format: double
|
|
description: 24-hour price change percentage.
|
|
change7d:
|
|
type: number
|
|
format: double
|
|
description: 7-day price change percentage.
|
|
image:
|
|
type: string
|
|
description: Coin image URL.
|
|
required:
|
|
- id
|
|
- symbol
|
|
description: Stablecoin represents a single stablecoin with peg health data.
|
|
ListEtfFlowsRequest:
|
|
type: object
|
|
description: ListEtfFlowsRequest is empty; the handler uses a fixed list of BTC spot ETFs.
|
|
ListEtfFlowsResponse:
|
|
type: object
|
|
properties:
|
|
timestamp:
|
|
type: string
|
|
description: Timestamp of the data fetch (ISO 8601).
|
|
summary:
|
|
$ref: '#/components/schemas/EtfFlowsSummary'
|
|
etfs:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/EtfFlow'
|
|
rateLimited:
|
|
type: boolean
|
|
description: True when the upstream API rate-limited the request.
|
|
description: ListEtfFlowsResponse contains BTC spot ETF flow data.
|
|
EtfFlowsSummary:
|
|
type: object
|
|
properties:
|
|
etfCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of ETFs with data.
|
|
totalVolume:
|
|
type: integer
|
|
format: int64
|
|
description: 'Total volume across all ETFs.. Warning: Values > 2^53 may lose precision in JavaScript'
|
|
totalEstFlow:
|
|
type: integer
|
|
format: int64
|
|
description: 'Total estimated flow across all ETFs.. Warning: Values > 2^53 may lose precision in JavaScript'
|
|
netDirection:
|
|
type: string
|
|
description: 'Net direction: "NET INFLOW", "NET OUTFLOW", or "NEUTRAL".'
|
|
inflowCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of ETFs with inflow.
|
|
outflowCount:
|
|
type: integer
|
|
format: int32
|
|
description: Number of ETFs with outflow.
|
|
description: EtfFlowsSummary contains aggregate ETF flow stats.
|
|
EtfFlow:
|
|
type: object
|
|
properties:
|
|
ticker:
|
|
type: string
|
|
minLength: 1
|
|
description: Ticker symbol (e.g. "IBIT").
|
|
issuer:
|
|
type: string
|
|
description: Fund issuer (e.g. "BlackRock").
|
|
price:
|
|
type: number
|
|
format: double
|
|
description: Latest closing price.
|
|
priceChange:
|
|
type: number
|
|
format: double
|
|
description: Day-over-day price change percentage.
|
|
volume:
|
|
type: integer
|
|
format: int64
|
|
description: 'Latest daily volume.. Warning: Values > 2^53 may lose precision in JavaScript'
|
|
avgVolume:
|
|
type: integer
|
|
format: int64
|
|
description: 'Average volume over prior days.. Warning: Values > 2^53 may lose precision in JavaScript'
|
|
volumeRatio:
|
|
type: number
|
|
format: double
|
|
description: Volume ratio (latest / average).
|
|
direction:
|
|
type: string
|
|
description: 'Flow direction: "inflow", "outflow", or "neutral".'
|
|
estFlow:
|
|
type: integer
|
|
format: int64
|
|
description: 'Estimated dollar flow magnitude.. Warning: Values > 2^53 may lose precision in JavaScript'
|
|
required:
|
|
- ticker
|
|
description: EtfFlow represents a single ETF with estimated flow data.
|
|
GetCountryStockIndexRequest:
|
|
type: object
|
|
properties:
|
|
countryCode:
|
|
type: string
|
|
pattern: ^[A-Z]{2}$
|
|
description: ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "JP").
|
|
required:
|
|
- countryCode
|
|
description: GetCountryStockIndexRequest specifies which country's stock index to retrieve.
|
|
GetCountryStockIndexResponse:
|
|
type: object
|
|
properties:
|
|
available:
|
|
type: boolean
|
|
description: Whether stock index data is available for this country.
|
|
code:
|
|
type: string
|
|
description: ISO 3166-1 alpha-2 country code.
|
|
symbol:
|
|
type: string
|
|
description: Ticker symbol (e.g., "^GSPC").
|
|
indexName:
|
|
type: string
|
|
description: Index name (e.g., "S&P 500").
|
|
price:
|
|
type: number
|
|
format: double
|
|
description: Latest closing price.
|
|
weekChangePercent:
|
|
type: number
|
|
format: double
|
|
description: Weekly change percentage.
|
|
currency:
|
|
type: string
|
|
description: Currency of the index.
|
|
fetchedAt:
|
|
type: string
|
|
description: When the data was fetched (ISO 8601).
|
|
description: GetCountryStockIndexResponse contains the country's primary stock index data.
|
|
ListGulfQuotesRequest:
|
|
type: object
|
|
ListGulfQuotesResponse:
|
|
type: object
|
|
properties:
|
|
quotes:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/GulfQuote'
|
|
rateLimited:
|
|
type: boolean
|
|
GulfQuote:
|
|
type: object
|
|
properties:
|
|
symbol:
|
|
type: string
|
|
name:
|
|
type: string
|
|
flag:
|
|
type: string
|
|
country:
|
|
type: string
|
|
type:
|
|
type: string
|
|
price:
|
|
type: number
|
|
format: double
|
|
change:
|
|
type: number
|
|
format: double
|
|
sparkline:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: double
|
|
description: GulfQuote represents a Gulf region market quote (index, currency, or oil).
|
|
AnalyzeStockRequest:
|
|
type: object
|
|
properties:
|
|
symbol:
|
|
type: string
|
|
maxLength: 32
|
|
minLength: 1
|
|
name:
|
|
type: string
|
|
maxLength: 120
|
|
includeNews:
|
|
type: boolean
|
|
required:
|
|
- symbol
|
|
AnalyzeStockResponse:
|
|
type: object
|
|
properties:
|
|
available:
|
|
type: boolean
|
|
symbol:
|
|
type: string
|
|
name:
|
|
type: string
|
|
display:
|
|
type: string
|
|
currency:
|
|
type: string
|
|
currentPrice:
|
|
type: number
|
|
format: double
|
|
changePercent:
|
|
type: number
|
|
format: double
|
|
signalScore:
|
|
type: number
|
|
format: double
|
|
signal:
|
|
type: string
|
|
trendStatus:
|
|
type: string
|
|
volumeStatus:
|
|
type: string
|
|
macdStatus:
|
|
type: string
|
|
rsiStatus:
|
|
type: string
|
|
summary:
|
|
type: string
|
|
action:
|
|
type: string
|
|
confidence:
|
|
type: string
|
|
technicalSummary:
|
|
type: string
|
|
newsSummary:
|
|
type: string
|
|
whyNow:
|
|
type: string
|
|
bullishFactors:
|
|
type: array
|
|
items:
|
|
type: string
|
|
riskFactors:
|
|
type: array
|
|
items:
|
|
type: string
|
|
supportLevels:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: double
|
|
resistanceLevels:
|
|
type: array
|
|
items:
|
|
type: number
|
|
format: double
|
|
headlines:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/StockAnalysisHeadline'
|
|
ma5:
|
|
type: number
|
|
format: double
|
|
ma10:
|
|
type: number
|
|
format: double
|
|
ma20:
|
|
type: number
|
|
format: double
|
|
ma60:
|
|
type: number
|
|
format: double
|
|
biasMa5:
|
|
type: number
|
|
format: double
|
|
biasMa10:
|
|
type: number
|
|
format: double
|
|
biasMa20:
|
|
type: number
|
|
format: double
|
|
volumeRatio5d:
|
|
type: number
|
|
format: double
|
|
rsi12:
|
|
type: number
|
|
format: double
|
|
macdDif:
|
|
type: number
|
|
format: double
|
|
macdDea:
|
|
type: number
|
|
format: double
|
|
macdBar:
|
|
type: number
|
|
format: double
|
|
provider:
|
|
type: string
|
|
model:
|
|
type: string
|
|
fallback:
|
|
type: boolean
|
|
newsSearched:
|
|
type: boolean
|
|
generatedAt:
|
|
type: string
|
|
analysisId:
|
|
type: string
|
|
analysisAt:
|
|
type: integer
|
|
format: int64
|
|
description: 'Warning: Values > 2^53 may lose precision in JavaScript'
|
|
stopLoss:
|
|
type: number
|
|
format: double
|
|
takeProfit:
|
|
type: number
|
|
format: double
|
|
engineVersion:
|
|
type: string
|
|
StockAnalysisHeadline:
|
|
type: object
|
|
properties:
|
|
title:
|
|
type: string
|
|
source:
|
|
type: string
|
|
link:
|
|
type: string
|
|
publishedAt:
|
|
type: integer
|
|
format: int64
|
|
description: 'Warning: Values > 2^53 may lose precision in JavaScript'
|
|
GetStockAnalysisHistoryRequest:
|
|
type: object
|
|
properties:
|
|
symbols:
|
|
type: array
|
|
items:
|
|
type: string
|
|
limitPerSymbol:
|
|
type: integer
|
|
maximum: 32
|
|
minimum: 1
|
|
format: int32
|
|
includeNews:
|
|
type: boolean
|
|
GetStockAnalysisHistoryResponse:
|
|
type: object
|
|
properties:
|
|
items:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/StockAnalysisHistoryItem'
|
|
StockAnalysisHistoryItem:
|
|
type: object
|
|
properties:
|
|
symbol:
|
|
type: string
|
|
snapshots:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/AnalyzeStockResponse'
|
|
BacktestStockRequest:
|
|
type: object
|
|
properties:
|
|
symbol:
|
|
type: string
|
|
maxLength: 32
|
|
minLength: 1
|
|
name:
|
|
type: string
|
|
maxLength: 120
|
|
evalWindowDays:
|
|
type: integer
|
|
maximum: 30
|
|
minimum: 3
|
|
format: int32
|
|
required:
|
|
- symbol
|
|
BacktestStockResponse:
|
|
type: object
|
|
properties:
|
|
available:
|
|
type: boolean
|
|
symbol:
|
|
type: string
|
|
name:
|
|
type: string
|
|
display:
|
|
type: string
|
|
currency:
|
|
type: string
|
|
evalWindowDays:
|
|
type: integer
|
|
format: int32
|
|
evaluationsRun:
|
|
type: integer
|
|
format: int32
|
|
actionableEvaluations:
|
|
type: integer
|
|
format: int32
|
|
winRate:
|
|
type: number
|
|
format: double
|
|
directionAccuracy:
|
|
type: number
|
|
format: double
|
|
avgSimulatedReturnPct:
|
|
type: number
|
|
format: double
|
|
cumulativeSimulatedReturnPct:
|
|
type: number
|
|
format: double
|
|
latestSignal:
|
|
type: string
|
|
latestSignalScore:
|
|
type: number
|
|
format: double
|
|
summary:
|
|
type: string
|
|
generatedAt:
|
|
type: string
|
|
evaluations:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/BacktestStockEvaluation'
|
|
engineVersion:
|
|
type: string
|
|
BacktestStockEvaluation:
|
|
type: object
|
|
properties:
|
|
analysisAt:
|
|
type: integer
|
|
format: int64
|
|
description: 'Warning: Values > 2^53 may lose precision in JavaScript'
|
|
signal:
|
|
type: string
|
|
signalScore:
|
|
type: number
|
|
format: double
|
|
entryPrice:
|
|
type: number
|
|
format: double
|
|
exitPrice:
|
|
type: number
|
|
format: double
|
|
simulatedReturnPct:
|
|
type: number
|
|
format: double
|
|
directionCorrect:
|
|
type: boolean
|
|
outcome:
|
|
type: string
|
|
stopLoss:
|
|
type: number
|
|
format: double
|
|
takeProfit:
|
|
type: number
|
|
format: double
|
|
analysisId:
|
|
type: string
|
|
ListStoredStockBacktestsRequest:
|
|
type: object
|
|
properties:
|
|
symbols:
|
|
type: array
|
|
items:
|
|
type: string
|
|
evalWindowDays:
|
|
type: integer
|
|
maximum: 30
|
|
minimum: 3
|
|
format: int32
|
|
ListStoredStockBacktestsResponse:
|
|
type: object
|
|
properties:
|
|
items:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/BacktestStockResponse'
|
|
ListCryptoSectorsRequest:
|
|
type: object
|
|
description: ListCryptoSectorsRequest retrieves crypto sector performance.
|
|
ListCryptoSectorsResponse:
|
|
type: object
|
|
properties:
|
|
sectors:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CryptoSector'
|
|
description: ListCryptoSectorsResponse contains crypto sector performance data.
|
|
CryptoSector:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Sector identifier.
|
|
name:
|
|
type: string
|
|
description: Sector display name.
|
|
change:
|
|
type: number
|
|
format: double
|
|
description: Average 24h percentage change across sector tokens.
|
|
description: CryptoSector represents performance data for a crypto market sector.
|
|
ListDefiTokensRequest:
|
|
type: object
|
|
description: ListDefiTokensRequest retrieves DeFi token prices.
|
|
ListDefiTokensResponse:
|
|
type: object
|
|
properties:
|
|
tokens:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CryptoQuote'
|
|
description: ListDefiTokensResponse contains DeFi token price data.
|
|
ListAiTokensRequest:
|
|
type: object
|
|
description: ListAiTokensRequest retrieves AI crypto token prices.
|
|
ListAiTokensResponse:
|
|
type: object
|
|
properties:
|
|
tokens:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CryptoQuote'
|
|
description: ListAiTokensResponse contains AI token price data.
|
|
ListOtherTokensRequest:
|
|
type: object
|
|
description: ListOtherTokensRequest retrieves other/trending crypto token prices.
|
|
ListOtherTokensResponse:
|
|
type: object
|
|
properties:
|
|
tokens:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CryptoQuote'
|
|
description: ListOtherTokensResponse contains other token price data.
|
|
GetFearGreedIndexRequest:
|
|
type: object
|
|
GetFearGreedIndexResponse:
|
|
type: object
|
|
properties:
|
|
compositeScore:
|
|
type: number
|
|
format: double
|
|
compositeLabel:
|
|
type: string
|
|
previousScore:
|
|
type: number
|
|
format: double
|
|
seededAt:
|
|
type: string
|
|
sentiment:
|
|
$ref: '#/components/schemas/FearGreedCategory'
|
|
volatility:
|
|
$ref: '#/components/schemas/FearGreedCategory'
|
|
positioning:
|
|
$ref: '#/components/schemas/FearGreedCategory'
|
|
trend:
|
|
$ref: '#/components/schemas/FearGreedCategory'
|
|
breadth:
|
|
$ref: '#/components/schemas/FearGreedCategory'
|
|
momentum:
|
|
$ref: '#/components/schemas/FearGreedCategory'
|
|
liquidity:
|
|
$ref: '#/components/schemas/FearGreedCategory'
|
|
credit:
|
|
$ref: '#/components/schemas/FearGreedCategory'
|
|
macro:
|
|
$ref: '#/components/schemas/FearGreedCategory'
|
|
crossAsset:
|
|
$ref: '#/components/schemas/FearGreedCategory'
|
|
vix:
|
|
type: number
|
|
format: double
|
|
hySpread:
|
|
type: number
|
|
format: double
|
|
yield10y:
|
|
type: number
|
|
format: double
|
|
putCallRatio:
|
|
type: number
|
|
format: double
|
|
pctAbove200d:
|
|
type: number
|
|
format: double
|
|
cnnFearGreed:
|
|
type: number
|
|
format: double
|
|
cnnLabel:
|
|
type: string
|
|
aaiiBull:
|
|
type: number
|
|
format: double
|
|
aaiiBear:
|
|
type: number
|
|
format: double
|
|
fedRate:
|
|
type: string
|
|
unavailable:
|
|
type: boolean
|
|
FearGreedCategory:
|
|
type: object
|
|
properties:
|
|
score:
|
|
type: number
|
|
format: double
|
|
weight:
|
|
type: number
|
|
format: double
|
|
contribution:
|
|
type: number
|
|
format: double
|
|
degraded:
|
|
type: boolean
|
|
inputsJson:
|
|
type: string
|