tn-financial-data 0.2.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -0
- package/dist/cli.js +514 -36
- package/dist/client/index.d.ts +127 -1
- package/dist/client/index.js +91 -5
- package/package.json +1 -1
- package/skills/tn-financial-data/SKILL.md +9 -3
- package/skills/tn-financial-data/references/cli.md +41 -0
package/README.md
CHANGED
|
@@ -26,6 +26,9 @@ This package is the hosted agent-facing surface only. The repo's website, local
|
|
|
26
26
|
## Features
|
|
27
27
|
|
|
28
28
|
- Company facts, financials, prices, news, insider trades, ownership, global rates, and raw SEC filings through one hosted API
|
|
29
|
+
- Multi-ticker resolve and snapshot reads for lower-latency agent workflows
|
|
30
|
+
- Earnings calendar, dividends, and stock splits through the same hosted read contract
|
|
31
|
+
- Cross-ticker news search over article title, summary, and body text with ticker, provider, publisher, and date filters
|
|
29
32
|
- Agent-friendly CLI with clean error output, scoped subcommand help, and self-description via `tn-financial-data describe opencli`
|
|
30
33
|
- Packaged skill bundle for Claude and OpenCode installs
|
|
31
34
|
- Typed TypeScript client from the root package export
|
|
@@ -64,8 +67,14 @@ https://api.truenorth-financial.ai/v1
|
|
|
64
67
|
|
|
65
68
|
```bash
|
|
66
69
|
tn-financial-data query resolve-ticker --query google
|
|
70
|
+
tn-financial-data query resolve-ticker --query google --query meta --query nvda
|
|
67
71
|
tn-financial-data query available-tickers
|
|
72
|
+
tn-financial-data query snapshot --tickers AAPL,MSFT,NVDA
|
|
73
|
+
tn-financial-data query financial-metrics-snapshot --tickers AAPL,MSFT,NVDA --period annual
|
|
74
|
+
tn-financial-data query earnings-calendar --tickers AAPL,MSFT --start-date 2026-04-02 --end-date 2026-04-16
|
|
75
|
+
tn-financial-data query dividends --ticker AAPL --limit 10
|
|
68
76
|
tn-financial-data query company --ticker AAPL
|
|
77
|
+
tn-financial-data query news-search --query "tariff semiconductor" --ticker NVDA --limit 10
|
|
69
78
|
tn-financial-data query filings --ticker AAPL --filing-type 8-K --limit 5
|
|
70
79
|
tn-financial-data query general-overview --ticker AAPL --period quarterly --financial-limit 4 --news-limit 5
|
|
71
80
|
tn-financial-data skill install --tool claude
|
|
@@ -89,13 +98,20 @@ Ownership semantics:
|
|
|
89
98
|
Common query examples:
|
|
90
99
|
|
|
91
100
|
```bash
|
|
101
|
+
tn-financial-data query snapshot --tickers AAPL,MSFT,NVDA
|
|
102
|
+
tn-financial-data query financial-metrics-snapshot --tickers AAPL,MSFT,NVDA --period annual
|
|
92
103
|
tn-financial-data query financials --ticker AAPL --period annual --statement all
|
|
93
104
|
tn-financial-data query financial-metrics --ticker AAPL --period annual --limit 4
|
|
94
105
|
tn-financial-data query earnings --ticker AAPL --period quarterly --limit 8
|
|
106
|
+
tn-financial-data query earnings-calendar --tickers AAPL,MSFT --start-date 2026-04-02 --end-date 2026-04-16
|
|
95
107
|
tn-financial-data query quarterly-highlights --ticker AAPL
|
|
108
|
+
tn-financial-data query dividends --ticker AAPL --limit 10
|
|
109
|
+
tn-financial-data query splits --ticker AAPL --limit 10
|
|
96
110
|
tn-financial-data query filings --ticker AAPL --filing-type 10-K,10-Q,8-K --limit 10
|
|
97
111
|
tn-financial-data query filing-items --ticker AAPL --accession-number 0000320193-26-000005 --item 2.02 --include-exhibits
|
|
98
112
|
tn-financial-data query prices --ticker AAPL --interval day --start-date 2025-01-01 --end-date 2025-01-31
|
|
113
|
+
tn-financial-data query news --ticker AAPL --limit 10
|
|
114
|
+
tn-financial-data query news-search --query "AI data center" --provider alpaca --limit 10
|
|
99
115
|
tn-financial-data query institutional-ownership --ticker AAPL --limit 20
|
|
100
116
|
tn-financial-data query investor-portfolio --investor vanguard --limit 20
|
|
101
117
|
tn-financial-data query global-rates --series ecb_refi,boe_sonia --limit 10
|
|
@@ -175,6 +191,17 @@ const client = new TnFinancialData({
|
|
|
175
191
|
const resolution = await client.resolveTicker("google");
|
|
176
192
|
console.log(resolution.status, resolution.resolved_ticker);
|
|
177
193
|
|
|
194
|
+
const batchResolution = await client.resolveTickers(["google", "meta", "nvda"]);
|
|
195
|
+
console.log(batchResolution.results.map((row) => `${row.query}:${row.status}`));
|
|
196
|
+
|
|
197
|
+
const calendar = await client.getEarningsCalendar({
|
|
198
|
+
tickers: ["NVDA", "KO"],
|
|
199
|
+
startDate: "2026-04-01",
|
|
200
|
+
endDate: "2026-06-30",
|
|
201
|
+
});
|
|
202
|
+
|
|
203
|
+
console.log(calendar.events.map((row) => `${row.ticker}:${row.event_date_start}`));
|
|
204
|
+
|
|
178
205
|
const filings = await client.getFilings("AAPL", {
|
|
179
206
|
filingTypes: ["8-K"],
|
|
180
207
|
limit: 3,
|
|
@@ -182,6 +209,14 @@ const filings = await client.getFilings("AAPL", {
|
|
|
182
209
|
|
|
183
210
|
console.log(filings.filings[0]?.accession_number);
|
|
184
211
|
|
|
212
|
+
const news = await client.searchNews("AI data center", {
|
|
213
|
+
ticker: "NVDA",
|
|
214
|
+
provider: "alpaca",
|
|
215
|
+
limit: 5,
|
|
216
|
+
});
|
|
217
|
+
|
|
218
|
+
console.log(news.news[0]?.title, news.count);
|
|
219
|
+
|
|
185
220
|
const filingItems = await client.getFilingItems("AAPL", {
|
|
186
221
|
accessionNumber: "0000320193-26-000005",
|
|
187
222
|
filingType: "8-K",
|