tn-financial-data 0.1.2 → 0.1.4

package/README.md

@@ -1,6 +1,6 @@
 # tn-financial-data
 
-Hosted US equity financial data for agents.
+Hosted US equity financial data and SEC filings for agents.
 
 `tn-financial-data` is the published agent-facing surface for the hosted API:
 
@@ -25,7 +25,7 @@ This package is the hosted agent-facing surface only. The repo's website, local
 
 ## Features
 
-- Company facts, financials, prices, news, insider trades, ownership, and global rates through one hosted API
+- Company facts, financials, prices, news, insider trades, ownership, global rates, and raw SEC filings through one hosted API
 - Agent-friendly CLI with clean error output, scoped subcommand help, and self-description via `tn-financial-data describe opencli`
 - Packaged skill bundle for Claude and OpenCode installs
 - Typed TypeScript client from the root package export
@@ -63,6 +63,7 @@ https://api.truenorth-financial.ai/v1
 ```bash
 tn-financial-data query available-tickers
 tn-financial-data query company --ticker AAPL
+tn-financial-data query filings --ticker AAPL --filing-type 8-K --limit 5
 tn-financial-data query general-overview --ticker AAPL --period quarterly --financial-limit 4 --news-limit 5
 tn-financial-data skill install --tool claude
 tn-financial-data describe opencli
@@ -89,6 +90,8 @@ tn-financial-data query financials --ticker AAPL --period annual --statement all
 tn-financial-data query financial-metrics --ticker AAPL --period annual --limit 4
 tn-financial-data query earnings --ticker AAPL --period quarterly --limit 8
 tn-financial-data query quarterly-highlights --ticker AAPL
+tn-financial-data query filings --ticker AAPL --filing-type 10-K,10-Q,8-K --limit 10
+tn-financial-data query filing-items --ticker AAPL --accession-number 0000320193-26-000005 --item 2.02 --include-exhibits
 tn-financial-data query prices --ticker AAPL --interval day --start-date 2025-01-01 --end-date 2025-01-31
 tn-financial-data query institutional-ownership --ticker AAPL --limit 20
 tn-financial-data query investor-portfolio --investor vanguard --limit 20
@@ -166,9 +169,22 @@ const client = new TnFinancialData({
   apiKey: process.env.TN_FINANCIAL_DATA_API_KEY!,
 });
 
-const company = await client.getCompanyFacts("AAPL");
-console.log(company.company_facts.name);
-console.log(company._rateLimit);
+const filings = await client.getFilings("AAPL", {
+  filingType: ["8-K"],
+  limit: 3,
+});
+
+console.log(filings.filings[0]?.accession_number);
+
+const filingItems = await client.getFilingItems("AAPL", {
+  accessionNumber: "0000320193-26-000005",
+  filingType: "8-K",
+  item: ["2.02"],
+  includeExhibits: true,
+});
+
+console.log(filingItems.filing_document.exhibits?.[0]?.number);
+console.log(filingItems._rateLimit);
 ```
 
 ## Package Scope