@fin.cx/opendata 3.5.0 → 3.5.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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +7 -21
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fin.cx/opendata",
3
- "version": "3.5.0",
3
+ "version": "3.5.1",
4
4
  "private": false,
5
5
  "description": "A comprehensive TypeScript library for accessing business data and real-time financial information. Features include German company data management with MongoDB integration, JSONL bulk processing, automated Handelsregister interactions, and real-time stock market data from multiple providers.",
6
6
  "main": "dist_ts/index.js",
package/readme.md CHANGED
@@ -19,13 +19,12 @@ pnpm add @fin.cx/opendata
19
19
  Get complete stock data with automatic enrichment - the elegant way:
20
20
 
21
21
  ```typescript
22
- import { StockDataService, YahooFinanceProvider, SecEdgarProvider } from '@fin.cx/opendata';
22
+ import { StockDataService, SecEdgarProvider } from '@fin.cx/opendata';
23
23
 
24
24
  // Initialize unified service
25
25
  const stockData = new StockDataService();
26
26
 
27
27
  // Register providers
28
- stockData.registerPriceProvider(new YahooFinanceProvider());
29
28
  stockData.registerFundamentalsProvider(new SecEdgarProvider({
30
29
  userAgent: 'YourCompany youremail@example.com'
31
30
  }));
@@ -68,10 +67,10 @@ stocks.forEach(stock => {
68
67
  If you only need prices without fundamentals:
69
68
 
70
69
  ```typescript
71
- import { StockDataService, YahooFinanceProvider } from '@fin.cx/opendata';
70
+ import { StockDataService, MarketstackProvider } from '@fin.cx/opendata';
72
71
 
73
72
  const stockData = new StockDataService();
74
- stockData.registerPriceProvider(new YahooFinanceProvider());
73
+ stockData.registerPriceProvider(new MarketstackProvider('YOUR_API_KEY'));
75
74
 
76
75
  // Get just the price
77
76
  const price = await stockData.getPrice('AAPL');
@@ -81,7 +80,7 @@ console.log(`${price.ticker}: $${price.price}`);
81
80
  import { StockPriceService } from '@fin.cx/opendata';
82
81
 
83
82
  const stockService = new StockPriceService({ ttl: 60000 });
84
- stockService.register(new YahooFinanceProvider());
83
+ stockService.register(new MarketstackProvider('YOUR_API_KEY'));
85
84
 
86
85
  const apple = await stockService.getData({ type: 'current', ticker: 'AAPL' });
87
86
  console.log(`${apple.companyFullName}: $${apple.price}`);
@@ -201,7 +200,7 @@ const details = await openData.handelsregister.getSpecificCompany({
201
200
 
202
201
  ### 📊 Stock & Crypto Market Module
203
202
 
204
- - **Real-Time Prices** - Live and EOD prices from Yahoo Finance, Marketstack, and CoinGecko
203
+ - **Real-Time Prices** - Live and EOD prices from Marketstack and CoinGecko
205
204
  - **Cryptocurrency Support** - 13M+ crypto tokens with 24/7 market data via CoinGecko
206
205
  - **Company Names** - Automatic company name extraction (e.g., "Apple Inc (NASDAQ:AAPL)")
207
206
  - **Historical Data** - Up to 15 years of daily EOD prices with pagination
@@ -238,11 +237,11 @@ const details = await openData.handelsregister.getSpecificCompany({
238
237
  Analyze multiple companies with automatic enrichment:
239
238
 
240
239
  ```typescript
241
- import { StockDataService, YahooFinanceProvider, SecEdgarProvider } from '@fin.cx/opendata';
240
+ import { StockDataService, MarketstackProvider, SecEdgarProvider } from '@fin.cx/opendata';
242
241
 
243
242
  // Setup unified service
244
243
  const stockData = new StockDataService();
245
- stockData.registerPriceProvider(new YahooFinanceProvider());
244
+ stockData.registerPriceProvider(new MarketstackProvider('YOUR_API_KEY'));
246
245
  stockData.registerFundamentalsProvider(new SecEdgarProvider({
247
246
  userAgent: 'YourCompany youremail@example.com'
248
247
  }));
@@ -487,12 +486,6 @@ stockService.register(new MarketstackProvider('YOUR_API_KEY'), {
487
486
  retryAttempts: 3,
488
487
  retryDelay: 1000
489
488
  });
490
-
491
- // Yahoo Finance - Real-time data (no API key)
492
- stockService.register(new YahooFinanceProvider(), {
493
- enabled: true,
494
- priority: 50
495
- });
496
489
  ```
497
490
 
498
491
  ### Fundamentals Service Options
@@ -666,13 +659,6 @@ interface IStockFundamentals {
666
659
  - ✅ Company names included automatically
667
660
  - ⚠️ Requires API key (free tier: 100 requests/month)
668
661
 
669
- **YahooFinanceProvider**
670
- - ✅ Real-time stock prices
671
- - ✅ No API key required
672
- - ✅ Global coverage
673
- - ✅ Company names included
674
- - ⚠️ Rate limits may apply
675
-
676
662
  **CoinGeckoProvider**
677
663
  - ✅ Cryptocurrency prices (Bitcoin, Ethereum, 13M+ tokens)
678
664
  - ✅ Current, historical, and intraday data