Skip to content

OpenStock is an open-source alternative to expensive market platforms. Track real-time prices, set personalized alerts, and explore detailed company insights — built openly, for everyone, forever free.

feat: add dividend yield card using real Finnhub data (#137)

Samra476d239cd068
diff --git a/app/(root)/stocks/[symbol]/page.tsx b/app/(root)/stocks/[symbol]/page.tsx
index 7b8d39d..4604bba 100644
--- a/app/(root)/stocks/[symbol]/page.tsx
+++ b/app/(root)/stocks/[symbol]/page.tsx
@@ -11,6 +11,7 @@ import {
COMPANY_FINANCIALS_WIDGET_CONFIG,
} from "@/lib/constants";
import { getStockSentimentInsights } from '@/lib/actions/adanos.actions';
+import { getStockMetrics } from '@/lib/actions/finnhub.actions';
import { formatSymbolForTradingView, isChartEmbeddable, tradingViewSymbolUrl } from '@/lib/utils';
const scriptUrl = `https://s3.tradingview.com/external-embedding/embed-widget-`;
@@ -25,6 +26,17 @@ async function Sentiment({ symbol }: { symbol: string }) {
);
}
+async function DividendYield({ symbol }: { symbol: string }) {
+ const dividendYield = await getStockMetrics(symbol);
+ return (
+ <Panel title="Dividend Yield">
+ <p className="text-2xl font-semibold text-white">
+ {dividendYield !== null ? `${dividendYield.toFixed(2)}%` : "—"}
+ </p>
+ </Panel>
+ );
+}
+
// Charts come straight from TradingView (live, no quota); only the header waits on Finnhub, and it streams.
export default async function StockDetails({ params }: StockDetailsPageProps) {
const { symbol: rawSymbol } = await params;
@@ -73,6 +85,9 @@ export default async function StockDetails({ params }: StockDetailsPageProps) {
height={400}
/>
</Panel>
+ <Suspense fallback={null}>
+ <DividendYield symbol={symbol} />
+ </Suspense>
<Suspense fallback={null}>
<Sentiment symbol={symbol} />
</Suspense>
diff --git a/lib/actions/finnhub.actions.ts b/lib/actions/finnhub.actions.ts
index 42c5a87..095f235 100644
--- a/lib/actions/finnhub.actions.ts
+++ b/lib/actions/finnhub.actions.ts
@@ -39,6 +39,12 @@ type FinnhubQuote = {
t?: number; // unix time of the last trade
};
+type FinnhubStockMetrics = {
+ metric?: {
+ dividendYieldIndicatedAnnual?: number | null;
+ };
+};
+
type FinnhubCompanyProfile = {
currency?: string;
exchange?: string;
@@ -196,6 +202,25 @@ export async function getCompanyProfile(symbol: string) {
}
}
+export async function getStockMetrics(symbol: string): Promise<number | null> {
+ if (FINNHUB_KEYS.length === 0) {
+ console.error('FINNHUB API key is not configured');
+ return null;
+ }
+
+ try {
+ const url = `${FINNHUB_BASE_URL}/stock/metric?symbol=${encodeURIComponent(symbol)}&metric=all`;
+ const data = await fetchJSON<FinnhubStockMetrics>(url, 3600);
+ const dividendYield = data?.metric?.dividendYieldIndicatedAnnual;
+ return typeof dividendYield === 'number' && Number.isFinite(dividendYield)
+ ? dividendYield
+ : null;
+ } catch (error) {
+ logFailure('stock metrics', symbol, error);
+ return null;
+ }
+}
+
export async function getWatchlistData(symbols: string[]) {
if (!symbols || symbols.length === 0) return [];