Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 909b30117b | |||
| 47fd770e48 | |||
| fdea1bb149 | |||
| 8286c30edf | |||
| ea76776ee1 | |||
| 54818293a1 | |||
| d49a738880 | |||
| 6273faa2f9 |
37
changelog.md
37
changelog.md
@@ -1,5 +1,42 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-11-02 - 3.3.0 - feat(stocks/CoinGeckoProvider)
|
||||
Add CoinGecko provider for cryptocurrency prices, export and tests, and update documentation
|
||||
|
||||
- Implemented CoinGeckoProvider with rate limiting, coin-id resolution, and support for current, batch, historical and intraday price endpoints
|
||||
- Added unit/integration tests for CoinGecko: test/test.coingecko.node+bun+deno.ts
|
||||
- Exported CoinGeckoProvider from ts/stocks/index.ts
|
||||
- Updated README and readme.hints.md with CoinGecko usage, provider notes and examples
|
||||
- Added .claude/settings.local.json with webfetch and bash permissions required for testing and CI
|
||||
|
||||
## 2025-11-01 - 3.2.2 - fix(handelsregister)
|
||||
Correct screenshot path handling in HandelsRegister and add local tool permissions
|
||||
|
||||
- ts/classes.handelsregister.ts: Replace string concatenation for screenshot path with a template literal and explicit string assertion to ensure the path is formed correctly for page.screenshot() and avoid type issues.
|
||||
- Add .claude/settings.local.json: Introduce local Claude settings that grant specific tool permissions used during development and testing (bash commands, web fetches, pnpm build, tstest, etc.).
|
||||
|
||||
## 2025-11-01 - 3.2.1 - fix(stocks/providers/provider.secedgar)
|
||||
Improve SEC EDGAR provider networking and error handling, update plugin path import, bump dev deps and add/refresh tests and lockfile
|
||||
|
||||
- SEC EDGAR provider: switch from SmartRequest to native fetch for ticker list and company facts, add AbortController-based timeouts, handle gzip automatically, improve response validation and error messages, and keep CIK/ticker-list caching
|
||||
- Improve timeout and rate-limit handling in SecEdgarProvider (uses native fetch + explicit timeout clear), plus clearer logging on failures
|
||||
- Update ts/plugins import to use node:path for Node compatibility
|
||||
- Bump devDependencies: @git.zone/tsrun to ^1.6.2 and @git.zone/tstest to ^2.7.0; bump @push.rocks/smartrequest to ^4.3.4
|
||||
- Add and refresh comprehensive test files (node/bun/deno variants) for fundamentals, marketstack, secedgar and stockdata services
|
||||
- Add deno.lock (dependency lock) and a local .claude/settings.local.json for CI/permissions
|
||||
|
||||
## 2025-11-01 - 3.2.0 - feat(StockDataService)
|
||||
Add unified StockDataService and BaseProviderService with new stockdata interfaces, provider integrations, tests and README updates
|
||||
|
||||
- Introduce StockDataService: unified API to fetch prices and fundamentals with automatic enrichment and caching
|
||||
- Add IStockData and IStockDataServiceConfig interfaces to define combined price+fundamentals payloads and configuration
|
||||
- Implement BaseProviderService abstraction to share provider registration, health, stats and caching logic
|
||||
- Add classes.stockdataservice.ts implementing batch/single fetch, enrichment, caching, health checks and provider stats
|
||||
- Export new stockdata module and classes from ts/stocks/index.ts
|
||||
- Add comprehensive tests: test/test.stockdata.service.node.ts to cover setup, provider registration, fetching, caching, enrichment, health and error handling
|
||||
- Update README with Unified Stock Data API examples, usage, and documentation reflecting new unified service
|
||||
- Minor infra: add .claude/settings.local.json permissions for local tooling and web fetch domains
|
||||
|
||||
## 2025-11-01 - 3.1.0 - feat(fundamentals)
|
||||
Add FundamentalsService and SEC EDGAR provider with caching, rate-limiting, tests, and docs updates
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@fin.cx/opendata",
|
||||
"version": "3.1.0",
|
||||
"version": "3.3.0",
|
||||
"private": false,
|
||||
"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.",
|
||||
"main": "dist_ts/index.js",
|
||||
@@ -16,8 +16,8 @@
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.6.8",
|
||||
"@git.zone/tsbundle": "^2.5.1",
|
||||
"@git.zone/tsrun": "^1.3.3",
|
||||
"@git.zone/tstest": "^2.4.2",
|
||||
"@git.zone/tsrun": "^1.6.2",
|
||||
"@git.zone/tstest": "^2.7.0",
|
||||
"@types/node": "^22.14.0"
|
||||
},
|
||||
"dependencies": {
|
||||
@@ -32,7 +32,7 @@
|
||||
"@push.rocks/smartlog": "^3.1.10",
|
||||
"@push.rocks/smartpath": "^6.0.0",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartrequest": "^4.3.1",
|
||||
"@push.rocks/smartrequest": "^4.3.4",
|
||||
"@push.rocks/smartstream": "^3.2.5",
|
||||
"@push.rocks/smartunique": "^3.0.9",
|
||||
"@push.rocks/smartxml": "^1.1.1",
|
||||
|
||||
1054
pnpm-lock.yaml
generated
1054
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -3,7 +3,7 @@
|
||||
## Stocks Module
|
||||
|
||||
### Overview
|
||||
The stocks module provides real-time stock price data through various provider implementations. Currently supports Yahoo Finance with an extensible architecture for additional providers.
|
||||
The stocks module provides real-time stock price data and cryptocurrency prices through various provider implementations. Currently supports Yahoo Finance, Marketstack, and CoinGecko with an extensible architecture for additional providers.
|
||||
|
||||
### Architecture
|
||||
- **Provider Pattern**: Each stock data source implements the `IStockProvider` interface
|
||||
@@ -31,11 +31,55 @@ const price = await stockService.getPrice({ ticker: 'AAPL' });
|
||||
console.log(`${price.ticker}: $${price.price}`);
|
||||
```
|
||||
|
||||
### CoinGecko Provider Notes
|
||||
- Cryptocurrency price provider supporting 13M+ tokens
|
||||
- Three main endpoints:
|
||||
- `/simple/price` - Current prices with market data (batch supported)
|
||||
- `/coins/{id}/market_chart` - Historical and intraday prices with OHLCV
|
||||
- `/coins/list` - Complete coin list for ticker-to-ID mapping
|
||||
- **Rate Limiting**:
|
||||
- Free tier: 5-15 calls/minute (no registration)
|
||||
- Demo plan: 30 calls/minute, 10,000/month (free with registration)
|
||||
- Custom rate limiter tracks requests per minute
|
||||
- **Ticker Resolution**:
|
||||
- Accepts both ticker symbols (BTC, ETH) and CoinGecko IDs (bitcoin, ethereum)
|
||||
- Lazy-loads coin list on first ticker resolution
|
||||
- Caches coin mappings for 24 hours
|
||||
- IDs with hyphens (wrapped-bitcoin) assumed to be CoinGecko IDs
|
||||
- **24/7 Markets**: Crypto markets always return `marketState: 'REGULAR'`
|
||||
- **Optional API Key**: Pass key to constructor for higher rate limits
|
||||
- Demo plan: `x-cg-demo-api-key` header
|
||||
- Paid plans: `x-cg-pro-api-key` header
|
||||
- **Data Granularity**:
|
||||
- Historical: Daily data for date ranges
|
||||
- Intraday: Hourly data only (1-90 days based on `days` param)
|
||||
- Current: Real-time prices with 24h change and volume
|
||||
|
||||
### Usage Example (Crypto)
|
||||
```typescript
|
||||
import { StockPriceService, CoinGeckoProvider } from '@fin.cx/opendata';
|
||||
|
||||
const stockService = new StockPriceService({ ttl: 30000 });
|
||||
const coingeckoProvider = new CoinGeckoProvider(); // or new CoinGeckoProvider('api-key')
|
||||
stockService.register(coingeckoProvider);
|
||||
|
||||
// Using ticker symbol
|
||||
const btc = await stockService.getPrice({ ticker: 'BTC' });
|
||||
console.log(`${btc.ticker}: $${btc.price}`);
|
||||
|
||||
// Using CoinGecko ID
|
||||
const ethereum = await stockService.getPrice({ ticker: 'ethereum' });
|
||||
|
||||
// Batch fetch
|
||||
const cryptos = await stockService.getPrices({ tickers: ['BTC', 'ETH', 'USDT'] });
|
||||
```
|
||||
|
||||
### Testing
|
||||
- Tests use real API calls (be mindful of rate limits)
|
||||
- Mock invalid ticker 'INVALID_TICKER_XYZ' for error testing
|
||||
- Clear cache between tests to ensure fresh data
|
||||
- The spark endpoint may return fewer results than requested
|
||||
- CoinGecko tests may take longer due to rate limiting (wait between requests)
|
||||
|
||||
### Future Providers
|
||||
To add a new provider:
|
||||
|
||||
266
readme.md
266
readme.md
@@ -14,64 +14,160 @@ pnpm add @fin.cx/opendata
|
||||
|
||||
## Quick Start
|
||||
|
||||
### 📈 Stock Market Data
|
||||
### ✨ Unified Stock Data API (Recommended)
|
||||
|
||||
Get real-time prices with company information included automatically:
|
||||
Get complete stock data with automatic enrichment - the elegant way:
|
||||
|
||||
```typescript
|
||||
import { StockPriceService, MarketstackProvider } from '@fin.cx/opendata';
|
||||
import { StockDataService, YahooFinanceProvider, SecEdgarProvider } from '@fin.cx/opendata';
|
||||
|
||||
// Initialize service with smart caching
|
||||
const stockService = new StockPriceService({
|
||||
ttl: 60000, // Cache TTL (historical cached forever)
|
||||
maxEntries: 10000
|
||||
// Initialize unified service
|
||||
const stockData = new StockDataService();
|
||||
|
||||
// Register providers
|
||||
stockData.registerPriceProvider(new YahooFinanceProvider());
|
||||
stockData.registerFundamentalsProvider(new SecEdgarProvider({
|
||||
userAgent: 'YourCompany youremail@example.com'
|
||||
}));
|
||||
|
||||
// ✨ Get complete stock data with ONE method call
|
||||
const apple = await stockData.getStockData('AAPL');
|
||||
|
||||
console.log({
|
||||
company: apple.fundamentals.companyName, // "Apple Inc."
|
||||
price: apple.price.price, // $270.37
|
||||
marketCap: apple.fundamentals.marketCap, // $4.13T (auto-calculated!)
|
||||
peRatio: apple.fundamentals.priceToEarnings, // 28.42 (auto-calculated!)
|
||||
pbRatio: apple.fundamentals.priceToBook, // 45.12 (auto-calculated!)
|
||||
eps: apple.fundamentals.earningsPerShareDiluted, // $6.13
|
||||
revenue: apple.fundamentals.revenue // $385.6B
|
||||
});
|
||||
|
||||
// Register provider with API key
|
||||
stockService.register(new MarketstackProvider('YOUR_API_KEY'));
|
||||
// Batch fetch with automatic enrichment
|
||||
const stocks = await stockData.getBatchStockData(['AAPL', 'MSFT', 'GOOGL']);
|
||||
|
||||
// Get current price with company name (zero extra API calls!)
|
||||
const apple = await stockService.getData({ type: 'current', ticker: 'AAPL' });
|
||||
|
||||
console.log(`${apple.companyFullName}: $${apple.price}`);
|
||||
// Output: "Apple Inc (NASDAQ:AAPL): $270.37"
|
||||
stocks.forEach(stock => {
|
||||
console.log(`${stock.ticker}: $${stock.price.price.toFixed(2)}, ` +
|
||||
`P/E ${stock.fundamentals?.priceToEarnings?.toFixed(2)}`);
|
||||
});
|
||||
// Output:
|
||||
// AAPL: $270.37, P/E 28.42
|
||||
// MSFT: $425.50, P/E 34.21
|
||||
// GOOGL: $142.15, P/E 25.63
|
||||
```
|
||||
|
||||
### 💰 Fundamental Financial Data
|
||||
**Why use the unified API?**
|
||||
- ✅ **Single service** for both prices and fundamentals
|
||||
- ✅ **Automatic enrichment** - Market cap, P/E, P/B calculated automatically
|
||||
- ✅ **One method call** - No manual `enrichWithPrice()` calls
|
||||
- ✅ **Simplified code** - Less boilerplate, more readable
|
||||
- ✅ **Type-safe** - Full TypeScript support
|
||||
|
||||
Access comprehensive financial metrics from SEC filings - completely FREE:
|
||||
### 📈 Price-Only Data (Alternative)
|
||||
|
||||
If you only need prices without fundamentals:
|
||||
|
||||
```typescript
|
||||
import { SecEdgarProvider, FundamentalsService } from '@fin.cx/opendata';
|
||||
import { StockDataService, YahooFinanceProvider } from '@fin.cx/opendata';
|
||||
|
||||
// Setup SEC EDGAR provider (no API key required!)
|
||||
const secEdgar = new SecEdgarProvider({
|
||||
userAgent: 'YourCompany youremail@example.com'
|
||||
const stockData = new StockDataService();
|
||||
stockData.registerPriceProvider(new YahooFinanceProvider());
|
||||
|
||||
// Get just the price
|
||||
const price = await stockData.getPrice('AAPL');
|
||||
console.log(`${price.ticker}: $${price.price}`);
|
||||
|
||||
// Or use StockPriceService directly for more control
|
||||
import { StockPriceService } from '@fin.cx/opendata';
|
||||
|
||||
const stockService = new StockPriceService({ ttl: 60000 });
|
||||
stockService.register(new YahooFinanceProvider());
|
||||
|
||||
const apple = await stockService.getData({ type: 'current', ticker: 'AAPL' });
|
||||
console.log(`${apple.companyFullName}: $${apple.price}`);
|
||||
```
|
||||
|
||||
### 🪙 Cryptocurrency Prices
|
||||
|
||||
Get real-time crypto prices with the CoinGecko provider:
|
||||
|
||||
```typescript
|
||||
import { StockPriceService, CoinGeckoProvider } from '@fin.cx/opendata';
|
||||
|
||||
const stockService = new StockPriceService({ ttl: 30000 });
|
||||
|
||||
// Optional: Pass API key for higher rate limits
|
||||
// const provider = new CoinGeckoProvider('your-api-key');
|
||||
const provider = new CoinGeckoProvider();
|
||||
|
||||
stockService.register(provider);
|
||||
|
||||
// Fetch single crypto price (using ticker symbol)
|
||||
const btc = await stockService.getPrice({ ticker: 'BTC' });
|
||||
console.log(`${btc.ticker}: $${btc.price.toLocaleString()}`);
|
||||
console.log(`24h Change: ${btc.changePercent.toFixed(2)}%`);
|
||||
console.log(`24h Volume: $${btc.volume?.toLocaleString()}`);
|
||||
|
||||
// Or use CoinGecko ID directly
|
||||
const ethereum = await stockService.getPrice({ ticker: 'ethereum' });
|
||||
|
||||
// Batch fetch multiple cryptos
|
||||
const cryptos = await stockService.getPrices({
|
||||
tickers: ['BTC', 'ETH', 'USDT', 'BNB', 'SOL']
|
||||
});
|
||||
|
||||
cryptos.forEach(crypto => {
|
||||
console.log(`${crypto.ticker}: $${crypto.price.toFixed(2)} (${crypto.changePercent >= 0 ? '+' : ''}${crypto.changePercent.toFixed(2)}%)`);
|
||||
});
|
||||
|
||||
// Historical crypto prices
|
||||
const history = await stockService.getData({
|
||||
type: 'historical',
|
||||
ticker: 'BTC',
|
||||
from: new Date('2025-01-01'),
|
||||
to: new Date('2025-01-31')
|
||||
});
|
||||
|
||||
// Intraday crypto prices (hourly)
|
||||
const intraday = await stockService.getData({
|
||||
type: 'intraday',
|
||||
ticker: 'ETH',
|
||||
interval: '1hour',
|
||||
limit: 24 // Last 24 hours
|
||||
});
|
||||
```
|
||||
|
||||
### 💰 Fundamentals-Only Data (Alternative)
|
||||
|
||||
If you only need fundamentals without prices:
|
||||
|
||||
```typescript
|
||||
import { StockDataService, SecEdgarProvider } from '@fin.cx/opendata';
|
||||
|
||||
const stockData = new StockDataService();
|
||||
stockData.registerFundamentalsProvider(new SecEdgarProvider({
|
||||
userAgent: 'YourCompany youremail@example.com'
|
||||
}));
|
||||
|
||||
// Get just fundamentals
|
||||
const fundamentals = await stockData.getFundamentals('AAPL');
|
||||
|
||||
console.log({
|
||||
company: fundamentals.companyName,
|
||||
eps: fundamentals.earningsPerShareDiluted,
|
||||
revenue: fundamentals.revenue,
|
||||
sharesOutstanding: fundamentals.sharesOutstanding
|
||||
});
|
||||
|
||||
// Or use FundamentalsService directly
|
||||
import { FundamentalsService } from '@fin.cx/opendata';
|
||||
|
||||
const fundamentalsService = new FundamentalsService();
|
||||
fundamentalsService.register(secEdgar);
|
||||
fundamentalsService.register(new SecEdgarProvider({
|
||||
userAgent: 'YourCompany youremail@example.com'
|
||||
}));
|
||||
|
||||
// Fetch fundamentals for Apple
|
||||
const fundamentals = await fundamentalsService.getFundamentals('AAPL');
|
||||
|
||||
console.log({
|
||||
company: fundamentals.companyName, // "Apple Inc."
|
||||
eps: fundamentals.earningsPerShareDiluted, // $6.13
|
||||
revenue: fundamentals.revenue, // $385.6B
|
||||
sharesOutstanding: fundamentals.sharesOutstanding // 15.3B
|
||||
});
|
||||
|
||||
// Calculate market cap and P/E ratio
|
||||
const price = await stockService.getData({ type: 'current', ticker: 'AAPL' });
|
||||
const enriched = await fundamentalsService.enrichWithPrice(fundamentals, price.price);
|
||||
|
||||
console.log({
|
||||
marketCap: `$${(enriched.marketCap! / 1_000_000_000_000).toFixed(2)}T`,
|
||||
peRatio: enriched.priceToEarnings!.toFixed(2),
|
||||
pbRatio: enriched.priceToBook?.toFixed(2)
|
||||
});
|
||||
// Output: { marketCap: "$2.65T", peRatio: "28.42", pbRatio: "45.12" }
|
||||
const data = await fundamentalsService.getFundamentals('AAPL');
|
||||
```
|
||||
|
||||
### 🏢 German Business Intelligence
|
||||
@@ -103,9 +199,10 @@ const details = await openData.handelsregister.getSpecificCompany({
|
||||
|
||||
## Features
|
||||
|
||||
### 📊 Stock Market Module
|
||||
### 📊 Stock & Crypto Market Module
|
||||
|
||||
- **Real-Time Prices** - Live and EOD stock prices from Yahoo Finance and Marketstack
|
||||
- **Real-Time Prices** - Live and EOD prices from Yahoo Finance, Marketstack, and CoinGecko
|
||||
- **Cryptocurrency Support** - 13M+ crypto tokens with 24/7 market data via CoinGecko
|
||||
- **Company Names** - Automatic company name extraction (e.g., "Apple Inc (NASDAQ:AAPL)")
|
||||
- **Historical Data** - Up to 15 years of daily EOD prices with pagination
|
||||
- **OHLCV Data** - Open, High, Low, Close, Volume for technical analysis
|
||||
@@ -136,44 +233,70 @@ const details = await openData.handelsregister.getSpecificCompany({
|
||||
|
||||
## Advanced Examples
|
||||
|
||||
### Combined Market Analysis
|
||||
### Combined Market Analysis (Unified API)
|
||||
|
||||
Combine price data with fundamentals for comprehensive analysis:
|
||||
Analyze multiple companies with automatic enrichment:
|
||||
|
||||
```typescript
|
||||
import { StockPriceService, MarketstackProvider, SecEdgarProvider, FundamentalsService } from '@fin.cx/opendata';
|
||||
import { StockDataService, YahooFinanceProvider, SecEdgarProvider } from '@fin.cx/opendata';
|
||||
|
||||
// Setup services
|
||||
const stockService = new StockPriceService({ ttl: 60000 });
|
||||
stockService.register(new MarketstackProvider('YOUR_API_KEY'));
|
||||
|
||||
const fundamentalsService = new FundamentalsService();
|
||||
fundamentalsService.register(new SecEdgarProvider({
|
||||
// Setup unified service
|
||||
const stockData = new StockDataService();
|
||||
stockData.registerPriceProvider(new YahooFinanceProvider());
|
||||
stockData.registerFundamentalsProvider(new SecEdgarProvider({
|
||||
userAgent: 'YourCompany youremail@example.com'
|
||||
}));
|
||||
|
||||
// Analyze multiple companies
|
||||
// Analyze multiple companies with ONE call
|
||||
const tickers = ['AAPL', 'MSFT', 'GOOGL', 'AMZN'];
|
||||
const stocks = await stockData.getBatchStockData(tickers);
|
||||
|
||||
// All metrics are automatically calculated!
|
||||
stocks.forEach(stock => {
|
||||
if (stock.fundamentals) {
|
||||
console.log(`\n${stock.fundamentals.companyName} (${stock.ticker})`);
|
||||
console.log(` Price: $${stock.price.price.toFixed(2)}`);
|
||||
console.log(` Market Cap: $${(stock.fundamentals.marketCap! / 1e9).toFixed(2)}B`);
|
||||
console.log(` P/E Ratio: ${stock.fundamentals.priceToEarnings!.toFixed(2)}`);
|
||||
console.log(` Revenue: $${(stock.fundamentals.revenue! / 1e9).toFixed(2)}B`);
|
||||
console.log(` EPS: $${stock.fundamentals.earningsPerShareDiluted!.toFixed(2)}`);
|
||||
}
|
||||
});
|
||||
|
||||
// Or analyze one-by-one with automatic enrichment
|
||||
for (const ticker of tickers) {
|
||||
// Get price and fundamentals in parallel
|
||||
const [price, fundamentals] = await Promise.all([
|
||||
stockService.getData({ type: 'current', ticker }),
|
||||
fundamentalsService.getFundamentals(ticker)
|
||||
]);
|
||||
const stock = await stockData.getStockData(ticker);
|
||||
|
||||
// Calculate metrics
|
||||
const enriched = await fundamentalsService.enrichWithPrice(fundamentals, price.price);
|
||||
|
||||
console.log(`\n${fundamentals.companyName} (${ticker})`);
|
||||
console.log(` Price: $${price.price.toFixed(2)}`);
|
||||
console.log(` Market Cap: $${(enriched.marketCap! / 1e9).toFixed(2)}B`);
|
||||
console.log(` P/E Ratio: ${enriched.priceToEarnings!.toFixed(2)}`);
|
||||
console.log(` Revenue: $${(fundamentals.revenue! / 1e9).toFixed(2)}B`);
|
||||
console.log(` EPS: $${fundamentals.earningsPerShareDiluted!.toFixed(2)}`);
|
||||
// Everything is already enriched - no manual calculations needed!
|
||||
console.log(`${ticker}: P/E ${stock.fundamentals?.priceToEarnings?.toFixed(2)}`);
|
||||
}
|
||||
```
|
||||
|
||||
### Fundamental Data Screening
|
||||
|
||||
Screen stocks by financial metrics:
|
||||
|
||||
```typescript
|
||||
// Fetch data for multiple tickers
|
||||
const tickers = ['AAPL', 'MSFT', 'GOOGL', 'AMZN', 'META', 'NVDA', 'TSLA'];
|
||||
const stocks = await stockData.getBatchStockData(tickers);
|
||||
|
||||
// Filter by criteria (all metrics auto-calculated!)
|
||||
const valueStocks = stocks.filter(stock => {
|
||||
const f = stock.fundamentals;
|
||||
return f &&
|
||||
f.priceToEarnings! < 30 && // P/E under 30
|
||||
f.priceToBook! < 10 && // P/B under 10
|
||||
f.revenue! > 100_000_000_000; // Revenue > $100B
|
||||
});
|
||||
|
||||
console.log('\n💎 Value Stocks:');
|
||||
valueStocks.forEach(stock => {
|
||||
console.log(`${stock.ticker}: P/E ${stock.fundamentals!.priceToEarnings!.toFixed(2)}, ` +
|
||||
`P/B ${stock.fundamentals!.priceToBook!.toFixed(2)}`);
|
||||
});
|
||||
```
|
||||
|
||||
### Historical Data Analysis
|
||||
|
||||
Fetch and analyze historical price trends:
|
||||
@@ -550,6 +673,15 @@ interface IStockFundamentals {
|
||||
- ✅ Company names included
|
||||
- ⚠️ Rate limits may apply
|
||||
|
||||
**CoinGeckoProvider**
|
||||
- ✅ Cryptocurrency prices (Bitcoin, Ethereum, 13M+ tokens)
|
||||
- ✅ Current, historical, and intraday data
|
||||
- ✅ 24/7 market data (crypto never closes)
|
||||
- ✅ OHLCV data with market cap and volume
|
||||
- ✅ Supports both ticker symbols (BTC, ETH) and CoinGecko IDs (bitcoin, ethereum)
|
||||
- ✅ 240+ networks, 1600+ exchanges
|
||||
- ℹ️ Optional API key (free tier: 30 requests/min, 10K/month)
|
||||
|
||||
**OpenData**
|
||||
- `start()` - Initialize MongoDB connection
|
||||
- `buildInitialDb()` - Import bulk data
|
||||
|
||||
261
test/test.coingecko.node+bun+deno.ts
Normal file
261
test/test.coingecko.node+bun+deno.ts
Normal file
@@ -0,0 +1,261 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as opendata from '../ts/index.js';
|
||||
|
||||
// Test data
|
||||
const testCryptos = ['BTC', 'ETH', 'USDT'];
|
||||
const testCryptoIds = ['bitcoin', 'ethereum', 'tether'];
|
||||
const invalidCrypto = 'INVALID_CRYPTO_XYZ_12345';
|
||||
|
||||
let stockService: opendata.StockPriceService;
|
||||
let coingeckoProvider: opendata.CoinGeckoProvider;
|
||||
|
||||
tap.test('should create StockPriceService instance', async () => {
|
||||
stockService = new opendata.StockPriceService({
|
||||
ttl: 30000, // 30 seconds cache
|
||||
maxEntries: 100
|
||||
});
|
||||
expect(stockService).toBeInstanceOf(opendata.StockPriceService);
|
||||
});
|
||||
|
||||
tap.test('should create CoinGeckoProvider instance without API key', async () => {
|
||||
coingeckoProvider = new opendata.CoinGeckoProvider();
|
||||
expect(coingeckoProvider).toBeInstanceOf(opendata.CoinGeckoProvider);
|
||||
expect(coingeckoProvider.name).toEqual('CoinGecko');
|
||||
expect(coingeckoProvider.requiresAuth).toEqual(false);
|
||||
expect(coingeckoProvider.priority).toEqual(90);
|
||||
});
|
||||
|
||||
tap.test('should register CoinGecko provider with the service', async () => {
|
||||
stockService.register(coingeckoProvider);
|
||||
const providers = stockService.getAllProviders();
|
||||
expect(providers).toContainEqual(coingeckoProvider);
|
||||
expect(stockService.getProvider('CoinGecko')).toEqual(coingeckoProvider);
|
||||
});
|
||||
|
||||
tap.test('should check CoinGecko provider health', async () => {
|
||||
const health = await stockService.checkProvidersHealth();
|
||||
expect(health.get('CoinGecko')).toEqual(true);
|
||||
});
|
||||
|
||||
tap.test('should fetch single crypto price using ticker symbol (BTC)', async () => {
|
||||
const price = await stockService.getPrice({ ticker: 'BTC' });
|
||||
|
||||
expect(price).toHaveProperty('ticker');
|
||||
expect(price).toHaveProperty('price');
|
||||
expect(price).toHaveProperty('currency');
|
||||
expect(price).toHaveProperty('change');
|
||||
expect(price).toHaveProperty('changePercent');
|
||||
expect(price).toHaveProperty('previousClose');
|
||||
expect(price).toHaveProperty('timestamp');
|
||||
expect(price).toHaveProperty('provider');
|
||||
expect(price).toHaveProperty('marketState');
|
||||
|
||||
expect(price.ticker).toEqual('BTC');
|
||||
expect(price.price).toBeGreaterThan(0);
|
||||
expect(price.currency).toEqual('USD');
|
||||
expect(price.provider).toEqual('CoinGecko');
|
||||
expect(price.marketState).toEqual('REGULAR'); // Crypto is 24/7
|
||||
expect(price.timestamp).toBeInstanceOf(Date);
|
||||
expect(price.dataType).toEqual('live');
|
||||
|
||||
console.log(`\n📊 BTC Price: $${price.price.toLocaleString('en-US', { minimumFractionDigits: 2, maximumFractionDigits: 2 })}`);
|
||||
console.log(` Change: ${price.changePercent >= 0 ? '+' : ''}${price.changePercent.toFixed(2)}%`);
|
||||
});
|
||||
|
||||
tap.test('should fetch single crypto price using CoinGecko ID (bitcoin)', async () => {
|
||||
// Clear cache to ensure fresh fetch
|
||||
stockService.clearCache();
|
||||
|
||||
const price = await stockService.getPrice({ ticker: 'bitcoin' });
|
||||
|
||||
expect(price.ticker).toEqual('BITCOIN');
|
||||
expect(price.price).toBeGreaterThan(0);
|
||||
expect(price.provider).toEqual('CoinGecko');
|
||||
expect(price.companyName).toInclude('Bitcoin');
|
||||
});
|
||||
|
||||
tap.test('should fetch multiple crypto prices (batch)', async () => {
|
||||
stockService.clearCache();
|
||||
|
||||
const prices = await stockService.getPrices({
|
||||
tickers: testCryptos
|
||||
});
|
||||
|
||||
expect(prices).toBeArray();
|
||||
expect(prices.length).toEqual(testCryptos.length);
|
||||
|
||||
for (const price of prices) {
|
||||
expect(testCryptos).toContain(price.ticker);
|
||||
expect(price.price).toBeGreaterThan(0);
|
||||
expect(price.provider).toEqual('CoinGecko');
|
||||
expect(price.marketState).toEqual('REGULAR');
|
||||
|
||||
console.log(`\n💰 ${price.ticker}: $${price.price.toLocaleString('en-US', { minimumFractionDigits: 2, maximumFractionDigits: 8 })}`);
|
||||
console.log(` Change 24h: ${price.changePercent >= 0 ? '+' : ''}${price.changePercent.toFixed(2)}%`);
|
||||
if (price.volume) {
|
||||
console.log(` Volume 24h: $${price.volume.toLocaleString('en-US')}`);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
tap.test('should fetch historical crypto prices', async () => {
|
||||
// Add delay to avoid rate limiting
|
||||
await new Promise(resolve => setTimeout(resolve, 3000));
|
||||
|
||||
const to = new Date();
|
||||
const from = new Date(to.getTime() - 7 * 24 * 60 * 60 * 1000); // 7 days ago
|
||||
|
||||
const prices = await stockService.getData({
|
||||
type: 'historical',
|
||||
ticker: 'BTC',
|
||||
from: from,
|
||||
to: to
|
||||
});
|
||||
|
||||
expect(prices).toBeArray();
|
||||
expect((prices as opendata.IStockPrice[]).length).toBeGreaterThan(0);
|
||||
|
||||
const pricesArray = prices as opendata.IStockPrice[];
|
||||
console.log(`\n📈 Historical BTC Prices (${pricesArray.length} days):`);
|
||||
|
||||
// Show first few and last few
|
||||
const toShow = Math.min(3, pricesArray.length);
|
||||
for (let i = 0; i < toShow; i++) {
|
||||
const price = pricesArray[i];
|
||||
const date = price.timestamp.toISOString().split('T')[0];
|
||||
console.log(` ${date}: $${price.price.toLocaleString('en-US', { minimumFractionDigits: 2, maximumFractionDigits: 2 })}`);
|
||||
}
|
||||
|
||||
if (pricesArray.length > toShow * 2) {
|
||||
console.log(' ...');
|
||||
}
|
||||
|
||||
for (let i = Math.max(toShow, pricesArray.length - toShow); i < pricesArray.length; i++) {
|
||||
const price = pricesArray[i];
|
||||
const date = price.timestamp.toISOString().split('T')[0];
|
||||
console.log(` ${date}: $${price.price.toLocaleString('en-US', { minimumFractionDigits: 2, maximumFractionDigits: 2 })}`);
|
||||
}
|
||||
|
||||
// Validate first entry
|
||||
const firstPrice = pricesArray[0];
|
||||
expect(firstPrice.ticker).toEqual('BTC');
|
||||
expect(firstPrice.dataType).toEqual('eod');
|
||||
expect(firstPrice.provider).toEqual('CoinGecko');
|
||||
});
|
||||
|
||||
tap.test('should fetch intraday crypto prices (hourly)', async () => {
|
||||
// Add delay to avoid rate limiting
|
||||
await new Promise(resolve => setTimeout(resolve, 3000));
|
||||
|
||||
const prices = await stockService.getData({
|
||||
type: 'intraday',
|
||||
ticker: 'ETH',
|
||||
interval: '1hour',
|
||||
limit: 12 // Last 12 hours
|
||||
});
|
||||
|
||||
expect(prices).toBeArray();
|
||||
expect((prices as opendata.IStockPrice[]).length).toBeGreaterThan(0);
|
||||
|
||||
const pricesArray = prices as opendata.IStockPrice[];
|
||||
console.log(`\n⏰ Intraday ETH Prices (hourly, last ${pricesArray.length} hours):`);
|
||||
|
||||
// Show first few entries
|
||||
const toShow = Math.min(5, pricesArray.length);
|
||||
for (let i = 0; i < toShow; i++) {
|
||||
const price = pricesArray[i];
|
||||
const time = price.timestamp.toISOString().replace('T', ' ').substring(0, 16);
|
||||
console.log(` ${time}: $${price.price.toLocaleString('en-US', { minimumFractionDigits: 2, maximumFractionDigits: 2 })}`);
|
||||
}
|
||||
|
||||
// Validate first entry
|
||||
const firstPrice = pricesArray[0];
|
||||
expect(firstPrice.ticker).toEqual('ETH');
|
||||
expect(firstPrice.dataType).toEqual('intraday');
|
||||
expect(firstPrice.provider).toEqual('CoinGecko');
|
||||
});
|
||||
|
||||
tap.test('should serve cached prices on subsequent requests', async () => {
|
||||
// First request - should hit the API
|
||||
const firstRequest = await stockService.getPrice({ ticker: 'BTC' });
|
||||
|
||||
// Second request - should be served from cache
|
||||
const secondRequest = await stockService.getPrice({ ticker: 'BTC' });
|
||||
|
||||
expect(secondRequest.ticker).toEqual(firstRequest.ticker);
|
||||
expect(secondRequest.price).toEqual(firstRequest.price);
|
||||
expect(secondRequest.timestamp).toEqual(firstRequest.timestamp);
|
||||
expect(secondRequest.fetchedAt).toEqual(firstRequest.fetchedAt);
|
||||
});
|
||||
|
||||
tap.test('should handle invalid crypto ticker gracefully', async () => {
|
||||
try {
|
||||
await stockService.getPrice({ ticker: invalidCrypto });
|
||||
throw new Error('Should have thrown an error for invalid ticker');
|
||||
} catch (error) {
|
||||
expect(error.message).toInclude('Failed to fetch');
|
||||
}
|
||||
});
|
||||
|
||||
tap.test('should support market checking', async () => {
|
||||
expect(coingeckoProvider.supportsMarket('CRYPTO')).toEqual(true);
|
||||
expect(coingeckoProvider.supportsMarket('BTC')).toEqual(true);
|
||||
expect(coingeckoProvider.supportsMarket('ETH')).toEqual(true);
|
||||
expect(coingeckoProvider.supportsMarket('NASDAQ')).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('should support ticker validation', async () => {
|
||||
expect(coingeckoProvider.supportsTicker('BTC')).toEqual(true);
|
||||
expect(coingeckoProvider.supportsTicker('bitcoin')).toEqual(true);
|
||||
expect(coingeckoProvider.supportsTicker('wrapped-bitcoin')).toEqual(true);
|
||||
expect(coingeckoProvider.supportsTicker('BTC!')).toEqual(false);
|
||||
expect(coingeckoProvider.supportsTicker('BTC@USD')).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('should display provider statistics', async () => {
|
||||
const stats = stockService.getProviderStats();
|
||||
const coingeckoStats = stats.get('CoinGecko');
|
||||
|
||||
expect(coingeckoStats).toBeTruthy();
|
||||
expect(coingeckoStats.successCount).toBeGreaterThan(0);
|
||||
|
||||
console.log('\n📊 CoinGecko Provider Statistics:');
|
||||
console.log(` Success Count: ${coingeckoStats.successCount}`);
|
||||
console.log(` Error Count: ${coingeckoStats.errorCount}`);
|
||||
if (coingeckoStats.lastError) {
|
||||
console.log(` Last Error: ${coingeckoStats.lastError}`);
|
||||
}
|
||||
});
|
||||
|
||||
tap.test('should display crypto price dashboard', async () => {
|
||||
// Add delay to avoid rate limiting
|
||||
await new Promise(resolve => setTimeout(resolve, 3000));
|
||||
|
||||
stockService.clearCache();
|
||||
|
||||
const cryptos = ['BTC', 'ETH', 'BNB', 'SOL', 'ADA'];
|
||||
const prices = await stockService.getPrices({ tickers: cryptos });
|
||||
|
||||
console.log('\n╔═══════════════════════════════════════════════════════════╗');
|
||||
console.log('║ 🌐 CRYPTOCURRENCY PRICE DASHBOARD ║');
|
||||
console.log('╠═══════════════════════════════════════════════════════════╣');
|
||||
|
||||
for (const price of prices) {
|
||||
const priceStr = `$${price.price.toLocaleString('en-US', { minimumFractionDigits: 2, maximumFractionDigits: 8 })}`;
|
||||
const changeStr = `${price.changePercent >= 0 ? '+' : ''}${price.changePercent.toFixed(2)}%`;
|
||||
const changeIcon = price.changePercent >= 0 ? '📈' : '📉';
|
||||
|
||||
console.log(`║ ${price.ticker.padEnd(6)} ${changeIcon} ${priceStr.padStart(20)} │ ${changeStr.padStart(10)} ║`);
|
||||
}
|
||||
|
||||
console.log('╚═══════════════════════════════════════════════════════════╝');
|
||||
console.log(`Provider: ${prices[0].provider} | Market State: ${prices[0].marketState} (24/7)`);
|
||||
console.log(`Fetched at: ${prices[0].fetchedAt.toISOString()}`);
|
||||
});
|
||||
|
||||
tap.test('should clear cache', async () => {
|
||||
stockService.clearCache();
|
||||
// Cache is cleared, no assertions needed
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
418
test/test.stockdata.service.node+bun+deno.ts
Normal file
418
test/test.stockdata.service.node+bun+deno.ts
Normal file
@@ -0,0 +1,418 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as opendata from '../ts/index.js';
|
||||
|
||||
const TEST_USER_AGENT = 'fin.cx test@fin.cx';
|
||||
|
||||
tap.test('StockDataService - Basic Setup', async () => {
|
||||
await tap.test('should create StockDataService instance', async () => {
|
||||
const service = new opendata.StockDataService({
|
||||
cache: {
|
||||
priceTTL: 60000, // 1 minute for testing
|
||||
fundamentalsTTL: 120000, // 2 minutes for testing
|
||||
maxEntries: 100
|
||||
}
|
||||
});
|
||||
|
||||
expect(service).toBeInstanceOf(opendata.StockDataService);
|
||||
|
||||
const stats = service.getCacheStats();
|
||||
expect(stats.priceCache.ttl).toEqual(60000);
|
||||
expect(stats.fundamentalsCache.ttl).toEqual(120000);
|
||||
expect(stats.maxEntries).toEqual(100);
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('StockDataService - Provider Registration', async () => {
|
||||
const service = new opendata.StockDataService();
|
||||
|
||||
await tap.test('should register price provider', async () => {
|
||||
const yahooProvider = new opendata.YahooFinanceProvider();
|
||||
service.registerPriceProvider(yahooProvider);
|
||||
|
||||
const providers = service.getPriceProviders();
|
||||
expect(providers.length).toEqual(1);
|
||||
expect(providers[0].name).toEqual('Yahoo Finance');
|
||||
});
|
||||
|
||||
await tap.test('should register fundamentals provider', async () => {
|
||||
const secProvider = new opendata.SecEdgarProvider({
|
||||
userAgent: TEST_USER_AGENT
|
||||
});
|
||||
service.registerFundamentalsProvider(secProvider);
|
||||
|
||||
const providers = service.getFundamentalsProviders();
|
||||
expect(providers.length).toEqual(1);
|
||||
expect(providers[0].name).toEqual('SEC EDGAR');
|
||||
});
|
||||
|
||||
await tap.test('should unregister providers', async () => {
|
||||
service.unregisterPriceProvider('Yahoo Finance');
|
||||
service.unregisterFundamentalsProvider('SEC EDGAR');
|
||||
|
||||
expect(service.getPriceProviders().length).toEqual(0);
|
||||
expect(service.getFundamentalsProviders().length).toEqual(0);
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('StockDataService - Price Fetching', async () => {
|
||||
const service = new opendata.StockDataService();
|
||||
const yahooProvider = new opendata.YahooFinanceProvider();
|
||||
service.registerPriceProvider(yahooProvider);
|
||||
|
||||
await tap.test('should fetch single price', async () => {
|
||||
const price = await service.getPrice('AAPL');
|
||||
|
||||
expect(price).toBeDefined();
|
||||
expect(price.ticker).toEqual('AAPL');
|
||||
expect(price.price).toBeGreaterThan(0);
|
||||
expect(price.provider).toEqual('Yahoo Finance');
|
||||
expect(price.timestamp).toBeInstanceOf(Date);
|
||||
|
||||
console.log(`\n💵 Single Price: ${price.ticker} = $${price.price.toFixed(2)}`);
|
||||
});
|
||||
|
||||
await tap.test('should fetch batch prices', async () => {
|
||||
const prices = await service.getPrices(['AAPL', 'MSFT', 'GOOGL']);
|
||||
|
||||
expect(prices).toBeInstanceOf(Array);
|
||||
expect(prices.length).toBeGreaterThan(0);
|
||||
expect(prices.length).toBeLessThanOrEqual(3);
|
||||
|
||||
console.log('\n💵 Batch Prices:');
|
||||
prices.forEach(p => {
|
||||
console.log(` ${p.ticker}: $${p.price.toFixed(2)}`);
|
||||
});
|
||||
});
|
||||
|
||||
await tap.test('should cache prices', async () => {
|
||||
// Clear cache
|
||||
service.clearCache();
|
||||
|
||||
const stats1 = service.getCacheStats();
|
||||
expect(stats1.priceCache.size).toEqual(0);
|
||||
|
||||
// Fetch price (should hit API)
|
||||
const start1 = Date.now();
|
||||
await service.getPrice('AAPL');
|
||||
const duration1 = Date.now() - start1;
|
||||
|
||||
const stats2 = service.getCacheStats();
|
||||
expect(stats2.priceCache.size).toEqual(1);
|
||||
|
||||
// Fetch again (should hit cache - much faster)
|
||||
const start2 = Date.now();
|
||||
await service.getPrice('AAPL');
|
||||
const duration2 = Date.now() - start2;
|
||||
|
||||
expect(duration2).toBeLessThan(duration1);
|
||||
|
||||
console.log('\n⚡ Cache Performance:');
|
||||
console.log(` First fetch: ${duration1}ms`);
|
||||
console.log(` Cached fetch: ${duration2}ms`);
|
||||
console.log(` Speedup: ${Math.round(duration1 / duration2)}x`);
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('StockDataService - Fundamentals Fetching', async () => {
|
||||
const service = new opendata.StockDataService();
|
||||
const secProvider = new opendata.SecEdgarProvider({
|
||||
userAgent: TEST_USER_AGENT
|
||||
});
|
||||
service.registerFundamentalsProvider(secProvider);
|
||||
|
||||
await tap.test('should fetch single fundamentals', async () => {
|
||||
const fundamentals = await service.getFundamentals('AAPL');
|
||||
|
||||
expect(fundamentals).toBeDefined();
|
||||
expect(fundamentals.ticker).toEqual('AAPL');
|
||||
expect(fundamentals.companyName).toEqual('Apple Inc.');
|
||||
expect(fundamentals.provider).toEqual('SEC EDGAR');
|
||||
expect(fundamentals.earningsPerShareDiluted).toBeGreaterThan(0);
|
||||
expect(fundamentals.sharesOutstanding).toBeGreaterThan(0);
|
||||
|
||||
console.log('\n📊 Single Fundamentals:');
|
||||
console.log(` ${fundamentals.ticker}: ${fundamentals.companyName}`);
|
||||
console.log(` EPS: $${fundamentals.earningsPerShareDiluted?.toFixed(2)}`);
|
||||
console.log(` Shares: ${(fundamentals.sharesOutstanding! / 1_000_000_000).toFixed(2)}B`);
|
||||
});
|
||||
|
||||
await tap.test('should fetch batch fundamentals', async () => {
|
||||
const fundamentals = await service.getBatchFundamentals(['AAPL', 'MSFT']);
|
||||
|
||||
expect(fundamentals).toBeInstanceOf(Array);
|
||||
expect(fundamentals.length).toEqual(2);
|
||||
|
||||
console.log('\n📊 Batch Fundamentals:');
|
||||
fundamentals.forEach(f => {
|
||||
console.log(` ${f.ticker}: ${f.companyName} - EPS: $${f.earningsPerShareDiluted?.toFixed(2)}`);
|
||||
});
|
||||
});
|
||||
|
||||
await tap.test('should cache fundamentals', async () => {
|
||||
// Clear cache
|
||||
service.clearCache();
|
||||
|
||||
const stats1 = service.getCacheStats();
|
||||
expect(stats1.fundamentalsCache.size).toEqual(0);
|
||||
|
||||
// Fetch fundamentals (should hit API)
|
||||
await service.getFundamentals('AAPL');
|
||||
|
||||
const stats2 = service.getCacheStats();
|
||||
expect(stats2.fundamentalsCache.size).toEqual(1);
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('StockDataService - Complete Stock Data', async () => {
|
||||
const service = new opendata.StockDataService();
|
||||
|
||||
// Register both providers
|
||||
const yahooProvider = new opendata.YahooFinanceProvider();
|
||||
const secProvider = new opendata.SecEdgarProvider({
|
||||
userAgent: TEST_USER_AGENT
|
||||
});
|
||||
|
||||
service.registerPriceProvider(yahooProvider);
|
||||
service.registerFundamentalsProvider(secProvider);
|
||||
|
||||
await tap.test('should fetch complete stock data with string', async () => {
|
||||
const data = await service.getStockData('AAPL');
|
||||
|
||||
expect(data).toBeDefined();
|
||||
expect(data.ticker).toEqual('AAPL');
|
||||
expect(data.price).toBeDefined();
|
||||
expect(data.price.ticker).toEqual('AAPL');
|
||||
expect(data.fundamentals).toBeDefined();
|
||||
expect(data.fundamentals?.ticker).toEqual('AAPL');
|
||||
expect(data.fetchedAt).toBeInstanceOf(Date);
|
||||
|
||||
// Check automatic enrichment
|
||||
expect(data.fundamentals?.marketCap).toBeDefined();
|
||||
expect(data.fundamentals?.priceToEarnings).toBeDefined();
|
||||
expect(data.fundamentals?.marketCap).toBeGreaterThan(0);
|
||||
expect(data.fundamentals?.priceToEarnings).toBeGreaterThan(0);
|
||||
|
||||
console.log('\n✨ Complete Stock Data (Auto-Enriched):');
|
||||
console.log(` ${data.ticker}: ${data.fundamentals?.companyName}`);
|
||||
console.log(` Price: $${data.price.price.toFixed(2)}`);
|
||||
console.log(` Market Cap: $${(data.fundamentals!.marketCap! / 1_000_000_000_000).toFixed(2)}T`);
|
||||
console.log(` P/E Ratio: ${data.fundamentals!.priceToEarnings!.toFixed(2)}`);
|
||||
});
|
||||
|
||||
await tap.test('should fetch complete stock data with request object', async () => {
|
||||
const data = await service.getStockData({
|
||||
ticker: 'MSFT',
|
||||
includeFundamentals: true,
|
||||
enrichFundamentals: true
|
||||
});
|
||||
|
||||
expect(data).toBeDefined();
|
||||
expect(data.ticker).toEqual('MSFT');
|
||||
expect(data.price).toBeDefined();
|
||||
expect(data.fundamentals).toBeDefined();
|
||||
expect(data.fundamentals?.marketCap).toBeDefined();
|
||||
expect(data.fundamentals?.priceToEarnings).toBeDefined();
|
||||
});
|
||||
|
||||
await tap.test('should fetch complete stock data without fundamentals', async () => {
|
||||
const data = await service.getStockData({
|
||||
ticker: 'GOOGL',
|
||||
includeFundamentals: false
|
||||
});
|
||||
|
||||
expect(data).toBeDefined();
|
||||
expect(data.ticker).toEqual('GOOGL');
|
||||
expect(data.price).toBeDefined();
|
||||
expect(data.fundamentals).toBeUndefined();
|
||||
});
|
||||
|
||||
await tap.test('should handle fundamentals fetch failure gracefully', async () => {
|
||||
// Try a ticker that might not have fundamentals
|
||||
const data = await service.getStockData({
|
||||
ticker: 'BTC-USD', // Crypto - no SEC filings
|
||||
includeFundamentals: true
|
||||
});
|
||||
|
||||
expect(data).toBeDefined();
|
||||
expect(data.price).toBeDefined();
|
||||
// Fundamentals might be undefined due to error
|
||||
console.log(`\n⚠️ ${data.ticker} - Price available, Fundamentals: ${data.fundamentals ? 'Yes' : 'No'}`);
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('StockDataService - Batch Complete Stock Data', async () => {
|
||||
const service = new opendata.StockDataService();
|
||||
|
||||
const yahooProvider = new opendata.YahooFinanceProvider();
|
||||
const secProvider = new opendata.SecEdgarProvider({
|
||||
userAgent: TEST_USER_AGENT
|
||||
});
|
||||
|
||||
service.registerPriceProvider(yahooProvider);
|
||||
service.registerFundamentalsProvider(secProvider);
|
||||
|
||||
await tap.test('should fetch batch complete data with array', async () => {
|
||||
const data = await service.getBatchStockData(['AAPL', 'MSFT']);
|
||||
|
||||
expect(data).toBeInstanceOf(Array);
|
||||
expect(data.length).toEqual(2);
|
||||
|
||||
data.forEach(stock => {
|
||||
expect(stock.ticker).toBeDefined();
|
||||
expect(stock.price).toBeDefined();
|
||||
expect(stock.fundamentals).toBeDefined();
|
||||
expect(stock.fundamentals?.marketCap).toBeGreaterThan(0);
|
||||
expect(stock.fundamentals?.priceToEarnings).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
console.log('\n✨ Batch Complete Data:');
|
||||
data.forEach(stock => {
|
||||
console.log(` ${stock.ticker}: Price $${stock.price.price.toFixed(2)}, P/E ${stock.fundamentals!.priceToEarnings!.toFixed(2)}`);
|
||||
});
|
||||
});
|
||||
|
||||
await tap.test('should fetch batch complete data with request object', async () => {
|
||||
const data = await service.getBatchStockData({
|
||||
tickers: ['AAPL', 'GOOGL'],
|
||||
includeFundamentals: true,
|
||||
enrichFundamentals: true
|
||||
});
|
||||
|
||||
expect(data).toBeInstanceOf(Array);
|
||||
expect(data.length).toEqual(2);
|
||||
|
||||
data.forEach(stock => {
|
||||
expect(stock.fundamentals?.marketCap).toBeGreaterThan(0);
|
||||
});
|
||||
});
|
||||
|
||||
await tap.test('should fetch batch without enrichment', async () => {
|
||||
const data = await service.getBatchStockData({
|
||||
tickers: ['AAPL', 'MSFT'],
|
||||
includeFundamentals: true,
|
||||
enrichFundamentals: false
|
||||
});
|
||||
|
||||
expect(data).toBeInstanceOf(Array);
|
||||
|
||||
// Check that fundamentals exist but enrichment might not be complete
|
||||
data.forEach(stock => {
|
||||
if (stock.fundamentals) {
|
||||
expect(stock.fundamentals.ticker).toBeDefined();
|
||||
expect(stock.fundamentals.companyName).toBeDefined();
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('StockDataService - Health & Statistics', async () => {
|
||||
const service = new opendata.StockDataService();
|
||||
|
||||
const yahooProvider = new opendata.YahooFinanceProvider();
|
||||
const secProvider = new opendata.SecEdgarProvider({
|
||||
userAgent: TEST_USER_AGENT
|
||||
});
|
||||
|
||||
service.registerPriceProvider(yahooProvider);
|
||||
service.registerFundamentalsProvider(secProvider);
|
||||
|
||||
await tap.test('should check providers health', async () => {
|
||||
const health = await service.checkProvidersHealth();
|
||||
|
||||
expect(health.size).toEqual(2);
|
||||
expect(health.get('Yahoo Finance (price)')).toBe(true);
|
||||
expect(health.get('SEC EDGAR (fundamentals)')).toBe(true);
|
||||
|
||||
console.log('\n💚 Provider Health:');
|
||||
health.forEach((isHealthy, name) => {
|
||||
console.log(` ${name}: ${isHealthy ? '✅ Healthy' : '❌ Unhealthy'}`);
|
||||
});
|
||||
});
|
||||
|
||||
await tap.test('should track provider statistics', async () => {
|
||||
// Make some requests to generate stats
|
||||
await service.getPrice('AAPL');
|
||||
await service.getFundamentals('AAPL');
|
||||
|
||||
const stats = service.getProviderStats();
|
||||
|
||||
expect(stats.size).toEqual(2);
|
||||
|
||||
const yahooStats = stats.get('Yahoo Finance');
|
||||
expect(yahooStats).toBeDefined();
|
||||
expect(yahooStats!.type).toEqual('price');
|
||||
expect(yahooStats!.successCount).toBeGreaterThan(0);
|
||||
|
||||
const secStats = stats.get('SEC EDGAR');
|
||||
expect(secStats).toBeDefined();
|
||||
expect(secStats!.type).toEqual('fundamentals');
|
||||
expect(secStats!.successCount).toBeGreaterThan(0);
|
||||
|
||||
console.log('\n📈 Provider Statistics:');
|
||||
stats.forEach((stat, name) => {
|
||||
console.log(` ${name} (${stat.type}): Success=${stat.successCount}, Errors=${stat.errorCount}`);
|
||||
});
|
||||
});
|
||||
|
||||
await tap.test('should clear all caches', async () => {
|
||||
service.clearCache();
|
||||
|
||||
const stats = service.getCacheStats();
|
||||
expect(stats.priceCache.size).toEqual(0);
|
||||
expect(stats.fundamentalsCache.size).toEqual(0);
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('StockDataService - Error Handling', async () => {
|
||||
await tap.test('should throw error when no price provider available', async () => {
|
||||
const service = new opendata.StockDataService();
|
||||
|
||||
try {
|
||||
await service.getPrice('AAPL');
|
||||
throw new Error('Should have thrown error');
|
||||
} catch (error) {
|
||||
expect(error.message).toContain('No price providers available');
|
||||
}
|
||||
});
|
||||
|
||||
await tap.test('should throw error when no fundamentals provider available', async () => {
|
||||
const service = new opendata.StockDataService();
|
||||
|
||||
try {
|
||||
await service.getFundamentals('AAPL');
|
||||
throw new Error('Should have thrown error');
|
||||
} catch (error) {
|
||||
expect(error.message).toContain('No fundamentals providers available');
|
||||
}
|
||||
});
|
||||
|
||||
await tap.test('should handle invalid ticker for price', async () => {
|
||||
const service = new opendata.StockDataService();
|
||||
const yahooProvider = new opendata.YahooFinanceProvider();
|
||||
service.registerPriceProvider(yahooProvider);
|
||||
|
||||
try {
|
||||
await service.getPrice('INVALIDTICKER123456');
|
||||
throw new Error('Should have thrown error');
|
||||
} catch (error) {
|
||||
expect(error.message).toContain('Failed to fetch price');
|
||||
}
|
||||
});
|
||||
|
||||
await tap.test('should handle invalid ticker for fundamentals', async () => {
|
||||
const service = new opendata.StockDataService();
|
||||
const secProvider = new opendata.SecEdgarProvider({
|
||||
userAgent: TEST_USER_AGENT
|
||||
});
|
||||
service.registerFundamentalsProvider(secProvider);
|
||||
|
||||
try {
|
||||
await service.getFundamentals('INVALIDTICKER123456');
|
||||
throw new Error('Should have thrown error');
|
||||
} catch (error) {
|
||||
expect(error.message).toContain('CIK not found');
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@fin.cx/opendata',
|
||||
version: '3.1.0',
|
||||
version: '3.3.0',
|
||||
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.'
|
||||
}
|
||||
|
||||
@@ -78,7 +78,7 @@ export class HandelsRegister {
|
||||
timeout: 30000,
|
||||
})
|
||||
.catch(async (err) => {
|
||||
await pageArg.screenshot({ path: this.downloadDir + '/error.png' });
|
||||
await pageArg.screenshot({ path: `${this.downloadDir}/error.png` as `${string}.png` });
|
||||
throw err;
|
||||
});
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// node native scope
|
||||
import * as path from 'path';
|
||||
import * as path from 'node:path';
|
||||
|
||||
export {
|
||||
path,
|
||||
|
||||
296
ts/stocks/classes.baseproviderservice.ts
Normal file
296
ts/stocks/classes.baseproviderservice.ts
Normal file
@@ -0,0 +1,296 @@
|
||||
import * as plugins from '../plugins.js';
|
||||
|
||||
/**
|
||||
* Base provider entry for tracking provider state
|
||||
*/
|
||||
export interface IBaseProviderEntry<TProvider> {
|
||||
provider: TProvider;
|
||||
config: IBaseProviderConfig;
|
||||
lastError?: Error;
|
||||
lastErrorTime?: Date;
|
||||
successCount: number;
|
||||
errorCount: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Base provider configuration
|
||||
*/
|
||||
export interface IBaseProviderConfig {
|
||||
enabled: boolean;
|
||||
priority: number;
|
||||
timeout?: number;
|
||||
retryAttempts?: number;
|
||||
retryDelay?: number;
|
||||
cacheTTL?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Base provider interface
|
||||
*/
|
||||
export interface IBaseProvider {
|
||||
name: string;
|
||||
priority: number;
|
||||
isAvailable(): Promise<boolean>;
|
||||
readonly requiresAuth: boolean;
|
||||
readonly rateLimit?: {
|
||||
requestsPerMinute: number;
|
||||
requestsPerDay?: number;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Cache entry for any data type
|
||||
*/
|
||||
export interface IBaseCacheEntry<TData> {
|
||||
data: TData;
|
||||
timestamp: Date;
|
||||
ttl: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Base service for managing data providers with caching
|
||||
* Shared logic extracted from StockPriceService and FundamentalsService
|
||||
*/
|
||||
export abstract class BaseProviderService<TProvider extends IBaseProvider, TData> {
|
||||
protected providers = new Map<string, IBaseProviderEntry<TProvider>>();
|
||||
protected cache = new Map<string, IBaseCacheEntry<TData>>();
|
||||
protected logger = console;
|
||||
|
||||
protected cacheConfig = {
|
||||
ttl: 60000, // Default 60 seconds
|
||||
maxEntries: 10000
|
||||
};
|
||||
|
||||
constructor(cacheConfig?: { ttl?: number; maxEntries?: number }) {
|
||||
if (cacheConfig) {
|
||||
this.cacheConfig = { ...this.cacheConfig, ...cacheConfig };
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Register a provider
|
||||
*/
|
||||
public register(provider: TProvider, config?: Partial<IBaseProviderConfig>): void {
|
||||
const defaultConfig: IBaseProviderConfig = {
|
||||
enabled: true,
|
||||
priority: provider.priority,
|
||||
timeout: 30000,
|
||||
retryAttempts: 2,
|
||||
retryDelay: 1000,
|
||||
cacheTTL: this.cacheConfig.ttl
|
||||
};
|
||||
|
||||
const mergedConfig = { ...defaultConfig, ...config };
|
||||
|
||||
this.providers.set(provider.name, {
|
||||
provider,
|
||||
config: mergedConfig,
|
||||
successCount: 0,
|
||||
errorCount: 0
|
||||
});
|
||||
|
||||
console.log(`Registered provider: ${provider.name}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Unregister a provider
|
||||
*/
|
||||
public unregister(providerName: string): void {
|
||||
this.providers.delete(providerName);
|
||||
console.log(`Unregistered provider: ${providerName}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a specific provider by name
|
||||
*/
|
||||
public getProvider(name: string): TProvider | undefined {
|
||||
return this.providers.get(name)?.provider;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all registered providers
|
||||
*/
|
||||
public getAllProviders(): TProvider[] {
|
||||
return Array.from(this.providers.values()).map(entry => entry.provider);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get enabled providers sorted by priority
|
||||
*/
|
||||
public getEnabledProviders(): TProvider[] {
|
||||
return Array.from(this.providers.values())
|
||||
.filter(entry => entry.config.enabled)
|
||||
.sort((a, b) => (b.config.priority || 0) - (a.config.priority || 0))
|
||||
.map(entry => entry.provider);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check health of all providers
|
||||
*/
|
||||
public async checkProvidersHealth(): Promise<Map<string, boolean>> {
|
||||
const health = new Map<string, boolean>();
|
||||
|
||||
for (const [name, entry] of this.providers) {
|
||||
if (!entry.config.enabled) {
|
||||
health.set(name, false);
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
const isAvailable = await entry.provider.isAvailable();
|
||||
health.set(name, isAvailable);
|
||||
} catch (error) {
|
||||
health.set(name, false);
|
||||
console.error(`Health check failed for ${name}:`, error);
|
||||
}
|
||||
}
|
||||
|
||||
return health;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get provider statistics
|
||||
*/
|
||||
public getProviderStats(): Map<
|
||||
string,
|
||||
{
|
||||
successCount: number;
|
||||
errorCount: number;
|
||||
lastError?: string;
|
||||
lastErrorTime?: Date;
|
||||
}
|
||||
> {
|
||||
const stats = new Map();
|
||||
|
||||
for (const [name, entry] of this.providers) {
|
||||
stats.set(name, {
|
||||
successCount: entry.successCount,
|
||||
errorCount: entry.errorCount,
|
||||
lastError: entry.lastError?.message,
|
||||
lastErrorTime: entry.lastErrorTime
|
||||
});
|
||||
}
|
||||
|
||||
return stats;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all cached data
|
||||
*/
|
||||
public clearCache(): void {
|
||||
this.cache.clear();
|
||||
console.log('Cache cleared');
|
||||
}
|
||||
|
||||
/**
|
||||
* Set cache TTL
|
||||
*/
|
||||
public setCacheTTL(ttl: number): void {
|
||||
this.cacheConfig.ttl = ttl;
|
||||
console.log(`Cache TTL set to ${ttl}ms`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get cache statistics
|
||||
*/
|
||||
public getCacheStats(): {
|
||||
size: number;
|
||||
maxEntries: number;
|
||||
ttl: number;
|
||||
} {
|
||||
return {
|
||||
size: this.cache.size,
|
||||
maxEntries: this.cacheConfig.maxEntries,
|
||||
ttl: this.cacheConfig.ttl
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch with retry logic
|
||||
*/
|
||||
protected async fetchWithRetry<T>(
|
||||
fetchFn: () => Promise<T>,
|
||||
config: IBaseProviderConfig
|
||||
): Promise<T> {
|
||||
const maxAttempts = config.retryAttempts || 1;
|
||||
let lastError: Error | undefined;
|
||||
|
||||
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
|
||||
try {
|
||||
return await fetchFn();
|
||||
} catch (error) {
|
||||
lastError = error as Error;
|
||||
|
||||
if (attempt < maxAttempts) {
|
||||
const delay = (config.retryDelay || 1000) * attempt;
|
||||
console.log(`Retry attempt ${attempt} after ${delay}ms`);
|
||||
await plugins.smartdelay.delayFor(delay);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
throw lastError || new Error('Unknown error during fetch');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get from cache if not expired
|
||||
*/
|
||||
protected getFromCache(key: string): TData | null {
|
||||
const entry = this.cache.get(key);
|
||||
|
||||
if (!entry) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Check if cache entry has expired
|
||||
const age = Date.now() - entry.timestamp.getTime();
|
||||
if (entry.ttl !== Infinity && age > entry.ttl) {
|
||||
this.cache.delete(key);
|
||||
return null;
|
||||
}
|
||||
|
||||
return entry.data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add to cache with TTL
|
||||
*/
|
||||
protected addToCache(key: string, data: TData, ttl?: number): void {
|
||||
// Enforce max entries limit
|
||||
if (this.cache.size >= this.cacheConfig.maxEntries) {
|
||||
// Remove oldest entry
|
||||
const oldestKey = this.cache.keys().next().value;
|
||||
if (oldestKey) {
|
||||
this.cache.delete(oldestKey);
|
||||
}
|
||||
}
|
||||
|
||||
this.cache.set(key, {
|
||||
data,
|
||||
timestamp: new Date(),
|
||||
ttl: ttl || this.cacheConfig.ttl
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Track successful fetch for provider
|
||||
*/
|
||||
protected trackSuccess(providerName: string): void {
|
||||
const entry = this.providers.get(providerName);
|
||||
if (entry) {
|
||||
entry.successCount++;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Track failed fetch for provider
|
||||
*/
|
||||
protected trackError(providerName: string, error: Error): void {
|
||||
const entry = this.providers.get(providerName);
|
||||
if (entry) {
|
||||
entry.errorCount++;
|
||||
entry.lastError = error;
|
||||
entry.lastErrorTime = new Date();
|
||||
}
|
||||
}
|
||||
}
|
||||
647
ts/stocks/classes.stockdataservice.ts
Normal file
647
ts/stocks/classes.stockdataservice.ts
Normal file
@@ -0,0 +1,647 @@
|
||||
import * as plugins from '../plugins.js';
|
||||
import type { IStockProvider, IProviderConfig } from './interfaces/provider.js';
|
||||
import type { IFundamentalsProvider, IFundamentalsProviderConfig, IStockFundamentals } from './interfaces/fundamentals.js';
|
||||
import type { IStockPrice, IStockDataRequest as IPriceRequest } from './interfaces/stockprice.js';
|
||||
import type { IStockData, IStockDataServiceConfig, ICompleteStockDataRequest, ICompleteStockDataBatchRequest } from './interfaces/stockdata.js';
|
||||
|
||||
interface IProviderEntry<T> {
|
||||
provider: T;
|
||||
config: IProviderConfig | IFundamentalsProviderConfig;
|
||||
lastError?: Error;
|
||||
lastErrorTime?: Date;
|
||||
successCount: number;
|
||||
errorCount: number;
|
||||
}
|
||||
|
||||
interface ICacheEntry<T> {
|
||||
data: T;
|
||||
timestamp: Date;
|
||||
ttl: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unified service for managing both stock prices and fundamentals
|
||||
* Provides automatic enrichment and convenient combined data access
|
||||
*/
|
||||
export class StockDataService {
|
||||
private priceProviders = new Map<string, IProviderEntry<IStockProvider>>();
|
||||
private fundamentalsProviders = new Map<string, IProviderEntry<IFundamentalsProvider>>();
|
||||
|
||||
private priceCache = new Map<string, ICacheEntry<IStockPrice | IStockPrice[]>>();
|
||||
private fundamentalsCache = new Map<string, ICacheEntry<IStockFundamentals | IStockFundamentals[]>>();
|
||||
|
||||
private logger = console;
|
||||
|
||||
private config: Required<IStockDataServiceConfig> = {
|
||||
cache: {
|
||||
priceTTL: 24 * 60 * 60 * 1000, // 24 hours
|
||||
fundamentalsTTL: 90 * 24 * 60 * 60 * 1000, // 90 days
|
||||
maxEntries: 10000
|
||||
},
|
||||
timeout: {
|
||||
price: 10000, // 10 seconds
|
||||
fundamentals: 30000 // 30 seconds
|
||||
}
|
||||
};
|
||||
|
||||
constructor(config?: IStockDataServiceConfig) {
|
||||
if (config) {
|
||||
this.config = {
|
||||
cache: { ...this.config.cache, ...config.cache },
|
||||
timeout: { ...this.config.timeout, ...config.timeout }
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// ========== Provider Management ==========
|
||||
|
||||
/**
|
||||
* Register a price provider
|
||||
*/
|
||||
public registerPriceProvider(provider: IStockProvider, config?: IProviderConfig): void {
|
||||
const defaultConfig: IProviderConfig = {
|
||||
enabled: true,
|
||||
priority: provider.priority,
|
||||
timeout: this.config.timeout.price,
|
||||
retryAttempts: 2,
|
||||
retryDelay: 1000
|
||||
};
|
||||
|
||||
const mergedConfig = { ...defaultConfig, ...config };
|
||||
|
||||
this.priceProviders.set(provider.name, {
|
||||
provider,
|
||||
config: mergedConfig,
|
||||
successCount: 0,
|
||||
errorCount: 0
|
||||
});
|
||||
|
||||
console.log(`Registered price provider: ${provider.name}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Register a fundamentals provider
|
||||
*/
|
||||
public registerFundamentalsProvider(
|
||||
provider: IFundamentalsProvider,
|
||||
config?: IFundamentalsProviderConfig
|
||||
): void {
|
||||
const defaultConfig: IFundamentalsProviderConfig = {
|
||||
enabled: true,
|
||||
priority: provider.priority,
|
||||
timeout: this.config.timeout.fundamentals,
|
||||
retryAttempts: 2,
|
||||
retryDelay: 1000,
|
||||
cacheTTL: this.config.cache.fundamentalsTTL
|
||||
};
|
||||
|
||||
const mergedConfig = { ...defaultConfig, ...config };
|
||||
|
||||
this.fundamentalsProviders.set(provider.name, {
|
||||
provider,
|
||||
config: mergedConfig,
|
||||
successCount: 0,
|
||||
errorCount: 0
|
||||
});
|
||||
|
||||
console.log(`Registered fundamentals provider: ${provider.name}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Unregister a price provider
|
||||
*/
|
||||
public unregisterPriceProvider(providerName: string): void {
|
||||
this.priceProviders.delete(providerName);
|
||||
console.log(`Unregistered price provider: ${providerName}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Unregister a fundamentals provider
|
||||
*/
|
||||
public unregisterFundamentalsProvider(providerName: string): void {
|
||||
this.fundamentalsProviders.delete(providerName);
|
||||
console.log(`Unregistered fundamentals provider: ${providerName}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all registered price providers
|
||||
*/
|
||||
public getPriceProviders(): IStockProvider[] {
|
||||
return Array.from(this.priceProviders.values()).map(entry => entry.provider);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all registered fundamentals providers
|
||||
*/
|
||||
public getFundamentalsProviders(): IFundamentalsProvider[] {
|
||||
return Array.from(this.fundamentalsProviders.values()).map(entry => entry.provider);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get enabled price providers sorted by priority
|
||||
*/
|
||||
private getEnabledPriceProviders(): IStockProvider[] {
|
||||
return Array.from(this.priceProviders.values())
|
||||
.filter(entry => entry.config.enabled)
|
||||
.sort((a, b) => (b.config.priority || 0) - (a.config.priority || 0))
|
||||
.map(entry => entry.provider);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get enabled fundamentals providers sorted by priority
|
||||
*/
|
||||
private getEnabledFundamentalsProviders(): IFundamentalsProvider[] {
|
||||
return Array.from(this.fundamentalsProviders.values())
|
||||
.filter(entry => entry.config.enabled)
|
||||
.sort((a, b) => (b.config.priority || 0) - (a.config.priority || 0))
|
||||
.map(entry => entry.provider);
|
||||
}
|
||||
|
||||
// ========== Data Fetching Methods ==========
|
||||
|
||||
/**
|
||||
* Get current price for a single ticker
|
||||
*/
|
||||
public async getPrice(ticker: string): Promise<IStockPrice> {
|
||||
const cacheKey = `price:${ticker}`;
|
||||
const cached = this.getFromCache(this.priceCache, cacheKey);
|
||||
|
||||
if (cached) {
|
||||
console.log(`Cache hit for price: ${ticker}`);
|
||||
return cached as IStockPrice;
|
||||
}
|
||||
|
||||
const providers = this.getEnabledPriceProviders();
|
||||
if (providers.length === 0) {
|
||||
throw new Error('No price providers available');
|
||||
}
|
||||
|
||||
let lastError: Error | undefined;
|
||||
|
||||
for (const provider of providers) {
|
||||
const entry = this.priceProviders.get(provider.name)!;
|
||||
|
||||
try {
|
||||
const result = await this.fetchWithRetry(
|
||||
() => provider.fetchData({ type: 'current', ticker }),
|
||||
entry.config
|
||||
);
|
||||
|
||||
entry.successCount++;
|
||||
|
||||
const price = result as IStockPrice;
|
||||
this.addToCache(this.priceCache, cacheKey, price, this.config.cache.priceTTL);
|
||||
|
||||
console.log(`Successfully fetched price for ${ticker} from ${provider.name}`);
|
||||
return price;
|
||||
} catch (error) {
|
||||
entry.errorCount++;
|
||||
entry.lastError = error as Error;
|
||||
entry.lastErrorTime = new Date();
|
||||
lastError = error as Error;
|
||||
|
||||
console.warn(`Provider ${provider.name} failed for ${ticker}: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
throw new Error(
|
||||
`Failed to fetch price for ${ticker} from all providers. Last error: ${lastError?.message}`
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get current prices for multiple tickers
|
||||
*/
|
||||
public async getPrices(tickers: string[]): Promise<IStockPrice[]> {
|
||||
const cacheKey = `prices:${tickers.sort().join(',')}`;
|
||||
const cached = this.getFromCache(this.priceCache, cacheKey);
|
||||
|
||||
if (cached) {
|
||||
console.log(`Cache hit for prices: ${tickers.length} tickers`);
|
||||
return cached as IStockPrice[];
|
||||
}
|
||||
|
||||
const providers = this.getEnabledPriceProviders();
|
||||
if (providers.length === 0) {
|
||||
throw new Error('No price providers available');
|
||||
}
|
||||
|
||||
let lastError: Error | undefined;
|
||||
|
||||
for (const provider of providers) {
|
||||
const entry = this.priceProviders.get(provider.name)!;
|
||||
|
||||
try {
|
||||
const result = await this.fetchWithRetry(
|
||||
() => provider.fetchData({ type: 'batch', tickers }),
|
||||
entry.config
|
||||
);
|
||||
|
||||
entry.successCount++;
|
||||
|
||||
const prices = result as IStockPrice[];
|
||||
this.addToCache(this.priceCache, cacheKey, prices, this.config.cache.priceTTL);
|
||||
|
||||
console.log(`Successfully fetched ${prices.length} prices from ${provider.name}`);
|
||||
return prices;
|
||||
} catch (error) {
|
||||
entry.errorCount++;
|
||||
entry.lastError = error as Error;
|
||||
entry.lastErrorTime = new Date();
|
||||
lastError = error as Error;
|
||||
|
||||
console.warn(`Provider ${provider.name} failed for batch prices: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
throw new Error(
|
||||
`Failed to fetch prices for ${tickers.length} tickers from all providers. Last error: ${lastError?.message}`
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get fundamentals for a single ticker
|
||||
*/
|
||||
public async getFundamentals(ticker: string): Promise<IStockFundamentals> {
|
||||
const cacheKey = `fundamentals:${ticker}`;
|
||||
const cached = this.getFromCache(this.fundamentalsCache, cacheKey);
|
||||
|
||||
if (cached) {
|
||||
console.log(`Cache hit for fundamentals: ${ticker}`);
|
||||
return cached as IStockFundamentals;
|
||||
}
|
||||
|
||||
const providers = this.getEnabledFundamentalsProviders();
|
||||
if (providers.length === 0) {
|
||||
throw new Error('No fundamentals providers available');
|
||||
}
|
||||
|
||||
let lastError: Error | undefined;
|
||||
|
||||
for (const provider of providers) {
|
||||
const entry = this.fundamentalsProviders.get(provider.name)!;
|
||||
|
||||
try {
|
||||
const result = await this.fetchWithRetry(
|
||||
() => provider.fetchData({ type: 'fundamentals-current', ticker }),
|
||||
entry.config
|
||||
);
|
||||
|
||||
entry.successCount++;
|
||||
|
||||
const fundamentals = result as IStockFundamentals;
|
||||
const ttl = (entry.config as IFundamentalsProviderConfig).cacheTTL || this.config.cache.fundamentalsTTL;
|
||||
this.addToCache(this.fundamentalsCache, cacheKey, fundamentals, ttl);
|
||||
|
||||
console.log(`Successfully fetched fundamentals for ${ticker} from ${provider.name}`);
|
||||
return fundamentals;
|
||||
} catch (error) {
|
||||
entry.errorCount++;
|
||||
entry.lastError = error as Error;
|
||||
entry.lastErrorTime = new Date();
|
||||
lastError = error as Error;
|
||||
|
||||
console.warn(`Provider ${provider.name} failed for ${ticker} fundamentals: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
throw new Error(
|
||||
`Failed to fetch fundamentals for ${ticker} from all providers. Last error: ${lastError?.message}`
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get fundamentals for multiple tickers
|
||||
*/
|
||||
public async getBatchFundamentals(tickers: string[]): Promise<IStockFundamentals[]> {
|
||||
const cacheKey = `fundamentals-batch:${tickers.sort().join(',')}`;
|
||||
const cached = this.getFromCache(this.fundamentalsCache, cacheKey);
|
||||
|
||||
if (cached) {
|
||||
console.log(`Cache hit for batch fundamentals: ${tickers.length} tickers`);
|
||||
return cached as IStockFundamentals[];
|
||||
}
|
||||
|
||||
const providers = this.getEnabledFundamentalsProviders();
|
||||
if (providers.length === 0) {
|
||||
throw new Error('No fundamentals providers available');
|
||||
}
|
||||
|
||||
let lastError: Error | undefined;
|
||||
|
||||
for (const provider of providers) {
|
||||
const entry = this.fundamentalsProviders.get(provider.name)!;
|
||||
|
||||
try {
|
||||
const result = await this.fetchWithRetry(
|
||||
() => provider.fetchData({ type: 'fundamentals-batch', tickers }),
|
||||
entry.config
|
||||
);
|
||||
|
||||
entry.successCount++;
|
||||
|
||||
const fundamentals = result as IStockFundamentals[];
|
||||
const ttl = (entry.config as IFundamentalsProviderConfig).cacheTTL || this.config.cache.fundamentalsTTL;
|
||||
this.addToCache(this.fundamentalsCache, cacheKey, fundamentals, ttl);
|
||||
|
||||
console.log(`Successfully fetched ${fundamentals.length} fundamentals from ${provider.name}`);
|
||||
return fundamentals;
|
||||
} catch (error) {
|
||||
entry.errorCount++;
|
||||
entry.lastError = error as Error;
|
||||
entry.lastErrorTime = new Date();
|
||||
lastError = error as Error;
|
||||
|
||||
console.warn(`Provider ${provider.name} failed for batch fundamentals: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
throw new Error(
|
||||
`Failed to fetch fundamentals for ${tickers.length} tickers from all providers. Last error: ${lastError?.message}`
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* ✨ Get complete stock data (price + fundamentals) with automatic enrichment
|
||||
*/
|
||||
public async getStockData(request: string | ICompleteStockDataRequest): Promise<IStockData> {
|
||||
const normalizedRequest = typeof request === 'string'
|
||||
? { ticker: request, includeFundamentals: true, enrichFundamentals: true }
|
||||
: { includeFundamentals: true, enrichFundamentals: true, ...request };
|
||||
|
||||
const price = await this.getPrice(normalizedRequest.ticker);
|
||||
|
||||
let fundamentals: IStockFundamentals | undefined;
|
||||
|
||||
if (normalizedRequest.includeFundamentals) {
|
||||
try {
|
||||
fundamentals = await this.getFundamentals(normalizedRequest.ticker);
|
||||
|
||||
// Enrich fundamentals with price calculations
|
||||
if (normalizedRequest.enrichFundamentals && fundamentals) {
|
||||
fundamentals = this.enrichWithPrice(fundamentals, price.price);
|
||||
}
|
||||
} catch (error) {
|
||||
console.warn(`Failed to fetch fundamentals for ${normalizedRequest.ticker}: ${error.message}`);
|
||||
// Continue without fundamentals
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
ticker: normalizedRequest.ticker,
|
||||
price,
|
||||
fundamentals,
|
||||
fetchedAt: new Date()
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* ✨ Get complete stock data for multiple tickers with automatic enrichment
|
||||
*/
|
||||
public async getBatchStockData(request: string[] | ICompleteStockDataBatchRequest): Promise<IStockData[]> {
|
||||
const normalizedRequest = Array.isArray(request)
|
||||
? { tickers: request, includeFundamentals: true, enrichFundamentals: true }
|
||||
: { includeFundamentals: true, enrichFundamentals: true, ...request };
|
||||
|
||||
const prices = await this.getPrices(normalizedRequest.tickers);
|
||||
const priceMap = new Map(prices.map(p => [p.ticker, p]));
|
||||
|
||||
let fundamentalsMap = new Map<string, IStockFundamentals>();
|
||||
|
||||
if (normalizedRequest.includeFundamentals) {
|
||||
try {
|
||||
const fundamentals = await this.getBatchFundamentals(normalizedRequest.tickers);
|
||||
|
||||
// Enrich with prices if requested
|
||||
if (normalizedRequest.enrichFundamentals) {
|
||||
for (const fund of fundamentals) {
|
||||
const price = priceMap.get(fund.ticker);
|
||||
if (price) {
|
||||
fundamentalsMap.set(fund.ticker, this.enrichWithPrice(fund, price.price));
|
||||
} else {
|
||||
fundamentalsMap.set(fund.ticker, fund);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
fundamentalsMap = new Map(fundamentals.map(f => [f.ticker, f]));
|
||||
}
|
||||
} catch (error) {
|
||||
console.warn(`Failed to fetch batch fundamentals: ${error.message}`);
|
||||
// Continue without fundamentals
|
||||
}
|
||||
}
|
||||
|
||||
return normalizedRequest.tickers.map(ticker => ({
|
||||
ticker,
|
||||
price: priceMap.get(ticker)!,
|
||||
fundamentals: fundamentalsMap.get(ticker),
|
||||
fetchedAt: new Date()
|
||||
}));
|
||||
}
|
||||
|
||||
// ========== Helper Methods ==========
|
||||
|
||||
/**
|
||||
* Enrich fundamentals with calculated metrics using current price
|
||||
*/
|
||||
private enrichWithPrice(fundamentals: IStockFundamentals, price: number): IStockFundamentals {
|
||||
const enriched = { ...fundamentals };
|
||||
|
||||
// Calculate market cap: price × shares outstanding
|
||||
if (fundamentals.sharesOutstanding) {
|
||||
enriched.marketCap = price * fundamentals.sharesOutstanding;
|
||||
}
|
||||
|
||||
// Calculate P/E ratio: price / EPS
|
||||
if (fundamentals.earningsPerShareDiluted && fundamentals.earningsPerShareDiluted > 0) {
|
||||
enriched.priceToEarnings = price / fundamentals.earningsPerShareDiluted;
|
||||
}
|
||||
|
||||
// Calculate price-to-book: market cap / stockholders equity
|
||||
if (enriched.marketCap && fundamentals.stockholdersEquity && fundamentals.stockholdersEquity > 0) {
|
||||
enriched.priceToBook = enriched.marketCap / fundamentals.stockholdersEquity;
|
||||
}
|
||||
|
||||
return enriched;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch with retry logic
|
||||
*/
|
||||
private async fetchWithRetry<T>(
|
||||
fetchFn: () => Promise<T>,
|
||||
config: IProviderConfig | IFundamentalsProviderConfig
|
||||
): Promise<T> {
|
||||
const maxAttempts = config.retryAttempts || 1;
|
||||
let lastError: Error | undefined;
|
||||
|
||||
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
|
||||
try {
|
||||
return await fetchFn();
|
||||
} catch (error) {
|
||||
lastError = error as Error;
|
||||
|
||||
if (attempt < maxAttempts) {
|
||||
const delay = (config.retryDelay || 1000) * attempt;
|
||||
console.log(`Retry attempt ${attempt} after ${delay}ms`);
|
||||
await plugins.smartdelay.delayFor(delay);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
throw lastError || new Error('Unknown error during fetch');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get from cache if not expired
|
||||
*/
|
||||
private getFromCache<T>(cache: Map<string, ICacheEntry<T>>, key: string): T | null {
|
||||
const entry = cache.get(key);
|
||||
|
||||
if (!entry) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Check if cache entry has expired
|
||||
const age = Date.now() - entry.timestamp.getTime();
|
||||
if (entry.ttl !== Infinity && age > entry.ttl) {
|
||||
cache.delete(key);
|
||||
return null;
|
||||
}
|
||||
|
||||
return entry.data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add to cache with TTL
|
||||
*/
|
||||
private addToCache<T>(cache: Map<string, ICacheEntry<T>>, key: string, data: T, ttl: number): void {
|
||||
// Enforce max entries limit
|
||||
if (cache.size >= this.config.cache.maxEntries) {
|
||||
// Remove oldest entry
|
||||
const oldestKey = cache.keys().next().value;
|
||||
if (oldestKey) {
|
||||
cache.delete(oldestKey);
|
||||
}
|
||||
}
|
||||
|
||||
cache.set(key, {
|
||||
data,
|
||||
timestamp: new Date(),
|
||||
ttl
|
||||
});
|
||||
}
|
||||
|
||||
// ========== Health & Statistics ==========
|
||||
|
||||
/**
|
||||
* Check health of all providers (both price and fundamentals)
|
||||
*/
|
||||
public async checkProvidersHealth(): Promise<Map<string, boolean>> {
|
||||
const health = new Map<string, boolean>();
|
||||
|
||||
// Check price providers
|
||||
for (const [name, entry] of this.priceProviders) {
|
||||
if (!entry.config.enabled) {
|
||||
health.set(`${name} (price)`, false);
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
const isAvailable = await entry.provider.isAvailable();
|
||||
health.set(`${name} (price)`, isAvailable);
|
||||
} catch (error) {
|
||||
health.set(`${name} (price)`, false);
|
||||
console.error(`Health check failed for ${name}:`, error);
|
||||
}
|
||||
}
|
||||
|
||||
// Check fundamentals providers
|
||||
for (const [name, entry] of this.fundamentalsProviders) {
|
||||
if (!entry.config.enabled) {
|
||||
health.set(`${name} (fundamentals)`, false);
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
const isAvailable = await entry.provider.isAvailable();
|
||||
health.set(`${name} (fundamentals)`, isAvailable);
|
||||
} catch (error) {
|
||||
health.set(`${name} (fundamentals)`, false);
|
||||
console.error(`Health check failed for ${name}:`, error);
|
||||
}
|
||||
}
|
||||
|
||||
return health;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get statistics for all providers
|
||||
*/
|
||||
public getProviderStats(): Map<
|
||||
string,
|
||||
{
|
||||
type: 'price' | 'fundamentals';
|
||||
successCount: number;
|
||||
errorCount: number;
|
||||
lastError?: string;
|
||||
lastErrorTime?: Date;
|
||||
}
|
||||
> {
|
||||
const stats = new Map();
|
||||
|
||||
// Price provider stats
|
||||
for (const [name, entry] of this.priceProviders) {
|
||||
stats.set(name, {
|
||||
type: 'price',
|
||||
successCount: entry.successCount,
|
||||
errorCount: entry.errorCount,
|
||||
lastError: entry.lastError?.message,
|
||||
lastErrorTime: entry.lastErrorTime
|
||||
});
|
||||
}
|
||||
|
||||
// Fundamentals provider stats
|
||||
for (const [name, entry] of this.fundamentalsProviders) {
|
||||
stats.set(name, {
|
||||
type: 'fundamentals',
|
||||
successCount: entry.successCount,
|
||||
errorCount: entry.errorCount,
|
||||
lastError: entry.lastError?.message,
|
||||
lastErrorTime: entry.lastErrorTime
|
||||
});
|
||||
}
|
||||
|
||||
return stats;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all caches
|
||||
*/
|
||||
public clearCache(): void {
|
||||
this.priceCache.clear();
|
||||
this.fundamentalsCache.clear();
|
||||
console.log('All caches cleared');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get cache statistics
|
||||
*/
|
||||
public getCacheStats(): {
|
||||
priceCache: { size: number; ttl: number };
|
||||
fundamentalsCache: { size: number; ttl: number };
|
||||
maxEntries: number;
|
||||
} {
|
||||
return {
|
||||
priceCache: {
|
||||
size: this.priceCache.size,
|
||||
ttl: this.config.cache.priceTTL
|
||||
},
|
||||
fundamentalsCache: {
|
||||
size: this.fundamentalsCache.size,
|
||||
ttl: this.config.cache.fundamentalsTTL
|
||||
},
|
||||
maxEntries: this.config.cache.maxEntries
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -2,12 +2,18 @@
|
||||
export * from './interfaces/stockprice.js';
|
||||
export * from './interfaces/provider.js';
|
||||
export * from './interfaces/fundamentals.js';
|
||||
export * from './interfaces/stockdata.js';
|
||||
|
||||
// Export main services
|
||||
export * from './classes.stockservice.js';
|
||||
export * from './classes.fundamentalsservice.js';
|
||||
export * from './classes.stockdataservice.js'; // ✨ New unified service
|
||||
|
||||
// Export base service (for advanced use cases)
|
||||
export * from './classes.baseproviderservice.js';
|
||||
|
||||
// Export providers
|
||||
export * from './providers/provider.yahoo.js';
|
||||
export * from './providers/provider.marketstack.js';
|
||||
export * from './providers/provider.secedgar.js';
|
||||
export * from './providers/provider.secedgar.js';
|
||||
export * from './providers/provider.coingecko.js';
|
||||
65
ts/stocks/interfaces/stockdata.ts
Normal file
65
ts/stocks/interfaces/stockdata.ts
Normal file
@@ -0,0 +1,65 @@
|
||||
import type { IStockPrice } from './stockprice.js';
|
||||
import type { IStockFundamentals } from './fundamentals.js';
|
||||
|
||||
/**
|
||||
* Combined stock data with price and fundamentals
|
||||
* All calculated metrics (market cap, P/E, P/B) are automatically included
|
||||
*/
|
||||
export interface IStockData {
|
||||
/** Stock ticker symbol */
|
||||
ticker: string;
|
||||
|
||||
/** Price information */
|
||||
price: IStockPrice;
|
||||
|
||||
/** Fundamental data (optional - may not be available for all stocks) */
|
||||
fundamentals?: IStockFundamentals;
|
||||
|
||||
/** When this combined data was fetched */
|
||||
fetchedAt: Date;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configuration for StockDataService
|
||||
*/
|
||||
export interface IStockDataServiceConfig {
|
||||
/** Cache configuration */
|
||||
cache?: {
|
||||
/** TTL for price data (default: 24 hours) */
|
||||
priceTTL?: number;
|
||||
/** TTL for fundamentals data (default: 90 days) */
|
||||
fundamentalsTTL?: number;
|
||||
/** Max cache entries (default: 10000) */
|
||||
maxEntries?: number;
|
||||
};
|
||||
|
||||
/** Provider timeouts */
|
||||
timeout?: {
|
||||
/** Timeout for price providers (default: 10000ms) */
|
||||
price?: number;
|
||||
/** Timeout for fundamentals providers (default: 30000ms) */
|
||||
fundamentals?: number;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Request type for getting complete stock data
|
||||
*/
|
||||
export interface ICompleteStockDataRequest {
|
||||
ticker: string;
|
||||
/** Whether to include fundamentals (default: true) */
|
||||
includeFundamentals?: boolean;
|
||||
/** Whether to enrich fundamentals with price calculations (default: true) */
|
||||
enrichFundamentals?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Batch request for multiple stocks
|
||||
*/
|
||||
export interface ICompleteStockDataBatchRequest {
|
||||
tickers: string[];
|
||||
/** Whether to include fundamentals (default: true) */
|
||||
includeFundamentals?: boolean;
|
||||
/** Whether to enrich fundamentals with price calculations (default: true) */
|
||||
enrichFundamentals?: boolean;
|
||||
}
|
||||
757
ts/stocks/providers/provider.coingecko.ts
Normal file
757
ts/stocks/providers/provider.coingecko.ts
Normal file
@@ -0,0 +1,757 @@
|
||||
import * as plugins from '../../plugins.js';
|
||||
import type { IStockProvider, IProviderConfig } from '../interfaces/provider.js';
|
||||
import type {
|
||||
IStockPrice,
|
||||
IStockDataRequest,
|
||||
IStockCurrentRequest,
|
||||
IStockHistoricalRequest,
|
||||
IStockIntradayRequest,
|
||||
IStockBatchCurrentRequest
|
||||
} from '../interfaces/stockprice.js';
|
||||
|
||||
/**
|
||||
* Custom error for rate limit exceeded responses
|
||||
*/
|
||||
class RateLimitError extends Error {
|
||||
constructor(
|
||||
message: string,
|
||||
public waitTime: number,
|
||||
public retryAfter?: number
|
||||
) {
|
||||
super(message);
|
||||
this.name = 'RateLimitError';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Rate limiter for CoinGecko API
|
||||
* Free tier (Demo): 30 requests per minute
|
||||
* Without registration: 5-15 requests per minute
|
||||
*/
|
||||
class RateLimiter {
|
||||
private requestTimes: number[] = [];
|
||||
private maxRequestsPerMinute: number;
|
||||
private consecutiveRateLimitErrors: number = 0;
|
||||
|
||||
constructor(maxRequestsPerMinute: number = 30) {
|
||||
this.maxRequestsPerMinute = maxRequestsPerMinute;
|
||||
}
|
||||
|
||||
public async waitForSlot(): Promise<void> {
|
||||
const now = Date.now();
|
||||
const oneMinuteAgo = now - 60000;
|
||||
|
||||
// Remove requests older than 1 minute
|
||||
this.requestTimes = this.requestTimes.filter(time => time > oneMinuteAgo);
|
||||
|
||||
// If we've hit the limit, wait
|
||||
if (this.requestTimes.length >= this.maxRequestsPerMinute) {
|
||||
const oldestRequest = this.requestTimes[0];
|
||||
const waitTime = 60000 - (now - oldestRequest) + 100; // +100ms buffer
|
||||
await plugins.smartdelay.delayFor(waitTime);
|
||||
return this.waitForSlot(); // Recursively check again
|
||||
}
|
||||
|
||||
// Record this request
|
||||
this.requestTimes.push(now);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get time in milliseconds until next request slot is available
|
||||
*/
|
||||
public getTimeUntilNextSlot(): number {
|
||||
const now = Date.now();
|
||||
const oneMinuteAgo = now - 60000;
|
||||
|
||||
// Clean old requests
|
||||
const recentRequests = this.requestTimes.filter(time => time > oneMinuteAgo);
|
||||
|
||||
if (recentRequests.length < this.maxRequestsPerMinute) {
|
||||
return 0; // Slot available now
|
||||
}
|
||||
|
||||
// Calculate wait time until oldest request expires
|
||||
const oldestRequest = recentRequests[0];
|
||||
return Math.max(0, 60000 - (now - oldestRequest) + 100);
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle rate limit error with exponential backoff
|
||||
* Returns wait time in milliseconds
|
||||
*/
|
||||
public handleRateLimitError(): number {
|
||||
this.consecutiveRateLimitErrors++;
|
||||
|
||||
// Exponential backoff: 1s, 2s, 4s, 8s, 16s, 32s, 60s (max)
|
||||
const baseWait = 1000; // 1 second
|
||||
const exponent = this.consecutiveRateLimitErrors - 1;
|
||||
const backoff = Math.min(
|
||||
baseWait * Math.pow(2, exponent),
|
||||
60000 // max 60 seconds
|
||||
);
|
||||
|
||||
// After 3 consecutive 429s, reduce rate limit to 80% as safety measure
|
||||
if (this.consecutiveRateLimitErrors >= 3) {
|
||||
const newLimit = Math.floor(this.maxRequestsPerMinute * 0.8);
|
||||
if (newLimit < this.maxRequestsPerMinute) {
|
||||
console.warn(
|
||||
`Adjusting rate limit from ${this.maxRequestsPerMinute} to ${newLimit} requests/min due to repeated 429 errors`
|
||||
);
|
||||
this.maxRequestsPerMinute = newLimit;
|
||||
}
|
||||
}
|
||||
|
||||
return backoff;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reset consecutive error count on successful request
|
||||
*/
|
||||
public resetErrors(): void {
|
||||
if (this.consecutiveRateLimitErrors > 0) {
|
||||
this.consecutiveRateLimitErrors = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Interface for coin list response
|
||||
*/
|
||||
interface ICoinListItem {
|
||||
id: string;
|
||||
symbol: string;
|
||||
name: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* CoinGecko Crypto Price Provider
|
||||
*
|
||||
* Documentation: https://docs.coingecko.com/v3.0.1/reference/endpoint-overview
|
||||
*
|
||||
* Features:
|
||||
* - Current crypto prices (single and batch)
|
||||
* - Historical price data with OHLCV
|
||||
* - 13M+ tokens, 240+ networks, 1600+ exchanges
|
||||
* - Accepts both ticker symbols (BTC, ETH) and CoinGecko IDs (bitcoin, ethereum)
|
||||
* - 24/7 market data (crypto never closes)
|
||||
*
|
||||
* Rate Limits:
|
||||
* - Free tier (no key): 5-15 requests/minute
|
||||
* - Demo plan (free with registration): ~30 requests/minute, 10,000/month
|
||||
* - Paid plans: Higher limits
|
||||
*
|
||||
* API Authentication:
|
||||
* - Optional API key for Demo/paid plans
|
||||
* - Header: x-cg-demo-api-key (Demo) or x-cg-pro-api-key (paid)
|
||||
*/
|
||||
export class CoinGeckoProvider implements IStockProvider {
|
||||
public name = 'CoinGecko';
|
||||
public priority = 90; // High priority for crypto, between Yahoo (100) and Marketstack (80)
|
||||
public readonly requiresAuth = false; // API key is optional
|
||||
public readonly rateLimit = {
|
||||
requestsPerMinute: 30, // Demo plan default
|
||||
requestsPerDay: 10000 // Demo plan monthly quota / 30
|
||||
};
|
||||
|
||||
private logger = console;
|
||||
private baseUrl = 'https://api.coingecko.com/api/v3';
|
||||
private apiKey?: string;
|
||||
private rateLimiter: RateLimiter;
|
||||
|
||||
// Coin mapping cache
|
||||
private coinMapCache = new Map<string, string>(); // ticker/id -> coingecko id
|
||||
private coinListLoadedAt: Date | null = null;
|
||||
private readonly coinListCacheTTL = 24 * 60 * 60 * 1000; // 24 hours
|
||||
|
||||
// Priority map for common crypto tickers (to avoid conflicts)
|
||||
private readonly priorityTickerMap = new Map<string, string>([
|
||||
['btc', 'bitcoin'],
|
||||
['eth', 'ethereum'],
|
||||
['usdt', 'tether'],
|
||||
['bnb', 'binancecoin'],
|
||||
['sol', 'solana'],
|
||||
['usdc', 'usd-coin'],
|
||||
['xrp', 'ripple'],
|
||||
['ada', 'cardano'],
|
||||
['doge', 'dogecoin'],
|
||||
['trx', 'tron'],
|
||||
['dot', 'polkadot'],
|
||||
['matic', 'matic-network'],
|
||||
['ltc', 'litecoin'],
|
||||
['shib', 'shiba-inu'],
|
||||
['avax', 'avalanche-2'],
|
||||
['link', 'chainlink'],
|
||||
['atom', 'cosmos'],
|
||||
['uni', 'uniswap'],
|
||||
['etc', 'ethereum-classic'],
|
||||
['xlm', 'stellar']
|
||||
]);
|
||||
|
||||
constructor(apiKey?: string, private config?: IProviderConfig) {
|
||||
this.apiKey = apiKey;
|
||||
this.rateLimiter = new RateLimiter(this.rateLimit.requestsPerMinute);
|
||||
}
|
||||
|
||||
/**
|
||||
* Unified data fetching method supporting all request types
|
||||
*/
|
||||
public async fetchData(request: IStockDataRequest): Promise<IStockPrice | IStockPrice[]> {
|
||||
switch (request.type) {
|
||||
case 'current':
|
||||
return this.fetchCurrentPrice(request);
|
||||
case 'batch':
|
||||
return this.fetchBatchCurrentPrices(request);
|
||||
case 'historical':
|
||||
return this.fetchHistoricalPrices(request);
|
||||
case 'intraday':
|
||||
return this.fetchIntradayPrices(request);
|
||||
default:
|
||||
throw new Error(`Unsupported request type: ${(request as any).type}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch current price for a single crypto
|
||||
*/
|
||||
private async fetchCurrentPrice(request: IStockCurrentRequest): Promise<IStockPrice> {
|
||||
return this.fetchWithRateLimitRetry(async () => {
|
||||
// Resolve ticker to CoinGecko ID
|
||||
const coinId = await this.resolveCoinId(request.ticker);
|
||||
|
||||
// Build URL
|
||||
const params = new URLSearchParams({
|
||||
ids: coinId,
|
||||
vs_currencies: 'usd',
|
||||
include_market_cap: 'true',
|
||||
include_24hr_vol: 'true',
|
||||
include_24hr_change: 'true',
|
||||
include_last_updated_at: 'true'
|
||||
});
|
||||
|
||||
const url = `${this.baseUrl}/simple/price?${params}`;
|
||||
|
||||
// Wait for rate limit slot
|
||||
await this.rateLimiter.waitForSlot();
|
||||
|
||||
// Make request
|
||||
const response = await plugins.smartrequest.SmartRequest.create()
|
||||
.url(url)
|
||||
.headers(this.buildHeaders())
|
||||
.timeout(this.config?.timeout || 10000)
|
||||
.get();
|
||||
|
||||
const responseData = await response.json() as any;
|
||||
|
||||
// Check for rate limit error
|
||||
if (this.isRateLimitError(responseData)) {
|
||||
const waitTime = this.rateLimiter.handleRateLimitError();
|
||||
throw new RateLimitError(
|
||||
`Rate limit exceeded for ${request.ticker}`,
|
||||
waitTime
|
||||
);
|
||||
}
|
||||
|
||||
if (!responseData[coinId]) {
|
||||
throw new Error(`No data found for ${request.ticker} (${coinId})`);
|
||||
}
|
||||
|
||||
return this.mapToStockPrice(request.ticker, coinId, responseData[coinId], 'live');
|
||||
}, `current price for ${request.ticker}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch batch current prices for multiple cryptos
|
||||
*/
|
||||
private async fetchBatchCurrentPrices(request: IStockBatchCurrentRequest): Promise<IStockPrice[]> {
|
||||
return this.fetchWithRateLimitRetry(async () => {
|
||||
// Resolve all tickers to CoinGecko IDs
|
||||
const coinIds = await Promise.all(
|
||||
request.tickers.map(ticker => this.resolveCoinId(ticker))
|
||||
);
|
||||
|
||||
// Build URL with comma-separated IDs
|
||||
const params = new URLSearchParams({
|
||||
ids: coinIds.join(','),
|
||||
vs_currencies: 'usd',
|
||||
include_market_cap: 'true',
|
||||
include_24hr_vol: 'true',
|
||||
include_24hr_change: 'true',
|
||||
include_last_updated_at: 'true'
|
||||
});
|
||||
|
||||
const url = `${this.baseUrl}/simple/price?${params}`;
|
||||
|
||||
// Wait for rate limit slot
|
||||
await this.rateLimiter.waitForSlot();
|
||||
|
||||
// Make request
|
||||
const response = await plugins.smartrequest.SmartRequest.create()
|
||||
.url(url)
|
||||
.headers(this.buildHeaders())
|
||||
.timeout(this.config?.timeout || 15000)
|
||||
.get();
|
||||
|
||||
const responseData = await response.json() as any;
|
||||
|
||||
// Check for rate limit error
|
||||
if (this.isRateLimitError(responseData)) {
|
||||
const waitTime = this.rateLimiter.handleRateLimitError();
|
||||
throw new RateLimitError(
|
||||
`Rate limit exceeded for batch request`,
|
||||
waitTime
|
||||
);
|
||||
}
|
||||
|
||||
const prices: IStockPrice[] = [];
|
||||
|
||||
// Map responses back to original tickers
|
||||
for (let i = 0; i < request.tickers.length; i++) {
|
||||
const ticker = request.tickers[i];
|
||||
const coinId = coinIds[i];
|
||||
|
||||
if (responseData[coinId]) {
|
||||
try {
|
||||
prices.push(this.mapToStockPrice(ticker, coinId, responseData[coinId], 'live'));
|
||||
} catch (error) {
|
||||
this.logger.warn(`Failed to parse data for ${ticker}:`, error);
|
||||
}
|
||||
} else {
|
||||
this.logger.warn(`No data returned for ${ticker} (${coinId})`);
|
||||
}
|
||||
}
|
||||
|
||||
if (prices.length === 0) {
|
||||
throw new Error('No valid price data received from batch request');
|
||||
}
|
||||
|
||||
return prices;
|
||||
}, `batch prices for ${request.tickers.length} tickers`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch historical prices with OHLCV data
|
||||
*/
|
||||
private async fetchHistoricalPrices(request: IStockHistoricalRequest): Promise<IStockPrice[]> {
|
||||
return this.fetchWithRateLimitRetry(async () => {
|
||||
const coinId = await this.resolveCoinId(request.ticker);
|
||||
|
||||
// Calculate days between dates
|
||||
const days = Math.ceil((request.to.getTime() - request.from.getTime()) / (1000 * 60 * 60 * 24));
|
||||
|
||||
// Build URL
|
||||
const params = new URLSearchParams({
|
||||
vs_currency: 'usd',
|
||||
days: days.toString(),
|
||||
interval: 'daily' // Explicit daily granularity for historical data
|
||||
});
|
||||
|
||||
const url = `${this.baseUrl}/coins/${coinId}/market_chart?${params}`;
|
||||
|
||||
// Wait for rate limit slot
|
||||
await this.rateLimiter.waitForSlot();
|
||||
|
||||
// Make request
|
||||
const response = await plugins.smartrequest.SmartRequest.create()
|
||||
.url(url)
|
||||
.headers(this.buildHeaders())
|
||||
.timeout(this.config?.timeout || 20000)
|
||||
.get();
|
||||
|
||||
const responseData = await response.json() as any;
|
||||
|
||||
// Check for rate limit error
|
||||
if (this.isRateLimitError(responseData)) {
|
||||
const waitTime = this.rateLimiter.handleRateLimitError();
|
||||
throw new RateLimitError(
|
||||
`Rate limit exceeded for historical ${request.ticker}`,
|
||||
waitTime
|
||||
);
|
||||
}
|
||||
|
||||
if (!responseData.prices || !Array.isArray(responseData.prices)) {
|
||||
this.logger.error(`Invalid API response for ${request.ticker}:`, JSON.stringify(responseData).substring(0, 500));
|
||||
throw new Error(`Invalid response format for ${request.ticker}: ${JSON.stringify(responseData).substring(0, 200)}`);
|
||||
}
|
||||
|
||||
const prices: IStockPrice[] = [];
|
||||
const priceData = responseData.prices;
|
||||
const marketCapData = responseData.market_caps || [];
|
||||
const volumeData = responseData.total_volumes || [];
|
||||
|
||||
// Process each data point
|
||||
for (let i = 0; i < priceData.length; i++) {
|
||||
const [timestamp, price] = priceData[i];
|
||||
const date = new Date(timestamp);
|
||||
|
||||
// Filter by date range
|
||||
if (date < request.from || date > request.to) continue;
|
||||
|
||||
const marketCap = marketCapData[i]?.[1];
|
||||
const volume = volumeData[i]?.[1];
|
||||
|
||||
// Calculate previous close for change calculation
|
||||
const previousClose = i > 0 ? priceData[i - 1][1] : price;
|
||||
const change = price - previousClose;
|
||||
const changePercent = previousClose !== 0 ? (change / previousClose) * 100 : 0;
|
||||
|
||||
prices.push({
|
||||
ticker: request.ticker.toUpperCase(),
|
||||
price: price,
|
||||
currency: 'USD',
|
||||
change: change,
|
||||
changePercent: changePercent,
|
||||
previousClose: previousClose,
|
||||
timestamp: date,
|
||||
provider: this.name,
|
||||
marketState: 'REGULAR', // Crypto markets are always open
|
||||
|
||||
// OHLCV data (note: market_chart doesn't provide OHLC, only close prices)
|
||||
volume: volume,
|
||||
|
||||
dataType: 'eod',
|
||||
fetchedAt: new Date(),
|
||||
|
||||
companyName: coinId.charAt(0).toUpperCase() + coinId.slice(1)
|
||||
});
|
||||
}
|
||||
|
||||
return prices;
|
||||
}, `historical prices for ${request.ticker}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch intraday prices with hourly intervals
|
||||
*/
|
||||
private async fetchIntradayPrices(request: IStockIntradayRequest): Promise<IStockPrice[]> {
|
||||
return this.fetchWithRateLimitRetry(async () => {
|
||||
const coinId = await this.resolveCoinId(request.ticker);
|
||||
|
||||
// Map interval to days parameter (CoinGecko auto-granularity)
|
||||
// For hourly data, request 1-7 days
|
||||
let days = 1;
|
||||
switch (request.interval) {
|
||||
case '1min':
|
||||
case '5min':
|
||||
case '10min':
|
||||
case '15min':
|
||||
case '30min':
|
||||
throw new Error('CoinGecko only supports hourly intervals in market_chart. Use interval: "1hour"');
|
||||
case '1hour':
|
||||
days = 1; // Last 24 hours with hourly granularity
|
||||
break;
|
||||
}
|
||||
|
||||
// Build URL (omit interval param for automatic granularity based on days)
|
||||
const params = new URLSearchParams({
|
||||
vs_currency: 'usd',
|
||||
days: days.toString()
|
||||
});
|
||||
|
||||
const url = `${this.baseUrl}/coins/${coinId}/market_chart?${params}`;
|
||||
|
||||
// Wait for rate limit slot
|
||||
await this.rateLimiter.waitForSlot();
|
||||
|
||||
// Make request
|
||||
const response = await plugins.smartrequest.SmartRequest.create()
|
||||
.url(url)
|
||||
.headers(this.buildHeaders())
|
||||
.timeout(this.config?.timeout || 15000)
|
||||
.get();
|
||||
|
||||
const responseData = await response.json() as any;
|
||||
|
||||
// Check for rate limit error
|
||||
if (this.isRateLimitError(responseData)) {
|
||||
const waitTime = this.rateLimiter.handleRateLimitError();
|
||||
throw new RateLimitError(
|
||||
`Rate limit exceeded for intraday ${request.ticker}`,
|
||||
waitTime
|
||||
);
|
||||
}
|
||||
|
||||
if (!responseData.prices || !Array.isArray(responseData.prices)) {
|
||||
this.logger.error(`Invalid API response for ${request.ticker}:`, JSON.stringify(responseData).substring(0, 500));
|
||||
throw new Error(`Invalid response format for ${request.ticker}: ${JSON.stringify(responseData).substring(0, 200)}`);
|
||||
}
|
||||
|
||||
const prices: IStockPrice[] = [];
|
||||
const priceData = responseData.prices;
|
||||
const marketCapData = responseData.market_caps || [];
|
||||
const volumeData = responseData.total_volumes || [];
|
||||
|
||||
// Apply limit if specified
|
||||
const limit = request.limit || priceData.length;
|
||||
const dataToProcess = priceData.slice(-limit);
|
||||
|
||||
for (let i = 0; i < dataToProcess.length; i++) {
|
||||
const actualIndex = priceData.length - limit + i;
|
||||
const [timestamp, price] = dataToProcess[i];
|
||||
const date = new Date(timestamp);
|
||||
|
||||
const marketCap = marketCapData[actualIndex]?.[1];
|
||||
const volume = volumeData[actualIndex]?.[1];
|
||||
|
||||
const previousClose = i > 0 ? dataToProcess[i - 1][1] : price;
|
||||
const change = price - previousClose;
|
||||
const changePercent = previousClose !== 0 ? (change / previousClose) * 100 : 0;
|
||||
|
||||
prices.push({
|
||||
ticker: request.ticker.toUpperCase(),
|
||||
price: price,
|
||||
currency: 'USD',
|
||||
change: change,
|
||||
changePercent: changePercent,
|
||||
previousClose: previousClose,
|
||||
timestamp: date,
|
||||
provider: this.name,
|
||||
marketState: 'REGULAR',
|
||||
|
||||
volume: volume,
|
||||
|
||||
dataType: 'intraday',
|
||||
fetchedAt: new Date(),
|
||||
|
||||
companyName: coinId.charAt(0).toUpperCase() + coinId.slice(1)
|
||||
});
|
||||
}
|
||||
|
||||
return prices;
|
||||
}, `intraday prices for ${request.ticker}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if CoinGecko API is available
|
||||
*/
|
||||
public async isAvailable(): Promise<boolean> {
|
||||
try {
|
||||
const url = `${this.baseUrl}/simple/price?ids=bitcoin&vs_currencies=usd`;
|
||||
|
||||
await this.rateLimiter.waitForSlot();
|
||||
|
||||
const response = await plugins.smartrequest.SmartRequest.create()
|
||||
.url(url)
|
||||
.headers(this.buildHeaders())
|
||||
.timeout(5000)
|
||||
.get();
|
||||
|
||||
const responseData = await response.json() as any;
|
||||
return responseData.bitcoin?.usd !== undefined;
|
||||
} catch (error) {
|
||||
this.logger.warn('CoinGecko provider is not available:', error);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a market/network is supported
|
||||
* CoinGecko supports 240+ networks
|
||||
*/
|
||||
public supportsMarket(market: string): boolean {
|
||||
// CoinGecko has extensive crypto network coverage
|
||||
const supportedNetworks = [
|
||||
'CRYPTO', 'BTC', 'ETH', 'BSC', 'POLYGON', 'AVALANCHE',
|
||||
'SOLANA', 'ARBITRUM', 'OPTIMISM', 'BASE'
|
||||
];
|
||||
return supportedNetworks.includes(market.toUpperCase());
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a ticker format is supported
|
||||
* Supports both ticker symbols (BTC) and CoinGecko IDs (bitcoin)
|
||||
*/
|
||||
public supportsTicker(ticker: string): boolean {
|
||||
// Accept alphanumeric with hyphens (for coin IDs like 'wrapped-bitcoin')
|
||||
return /^[A-Za-z0-9\-]{1,50}$/.test(ticker);
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve ticker symbol or CoinGecko ID to canonical CoinGecko ID
|
||||
* Supports both formats: "BTC" -> "bitcoin", "bitcoin" -> "bitcoin"
|
||||
*/
|
||||
private async resolveCoinId(tickerOrId: string): Promise<string> {
|
||||
const normalized = tickerOrId.toLowerCase();
|
||||
|
||||
// Check priority map first (for common cryptos)
|
||||
if (this.priorityTickerMap.has(normalized)) {
|
||||
const coinId = this.priorityTickerMap.get(normalized)!;
|
||||
this.coinMapCache.set(normalized, coinId);
|
||||
return coinId;
|
||||
}
|
||||
|
||||
// Check cache
|
||||
if (this.coinMapCache.has(normalized)) {
|
||||
return this.coinMapCache.get(normalized)!;
|
||||
}
|
||||
|
||||
// Check if it's already a valid CoinGecko ID (contains hyphens or is all lowercase with original case)
|
||||
if (normalized.includes('-') || normalized === tickerOrId) {
|
||||
// Assume it's a CoinGecko ID, cache it
|
||||
this.coinMapCache.set(normalized, normalized);
|
||||
return normalized;
|
||||
}
|
||||
|
||||
// Load coin list if needed
|
||||
if (!this.coinListLoadedAt ||
|
||||
Date.now() - this.coinListLoadedAt.getTime() > this.coinListCacheTTL) {
|
||||
await this.loadCoinList();
|
||||
}
|
||||
|
||||
// Try to find in cache after loading
|
||||
if (this.coinMapCache.has(normalized)) {
|
||||
return this.coinMapCache.get(normalized)!;
|
||||
}
|
||||
|
||||
// Not found - return as-is and let API handle the error
|
||||
this.logger.warn(`Could not resolve ticker ${tickerOrId} to CoinGecko ID, using as-is`);
|
||||
return normalized;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load complete coin list from CoinGecko API
|
||||
*/
|
||||
private async loadCoinList(): Promise<void> {
|
||||
try {
|
||||
const url = `${this.baseUrl}/coins/list`;
|
||||
|
||||
await this.rateLimiter.waitForSlot();
|
||||
|
||||
const response = await plugins.smartrequest.SmartRequest.create()
|
||||
.url(url)
|
||||
.headers(this.buildHeaders())
|
||||
.timeout(10000)
|
||||
.get();
|
||||
|
||||
const coinList = await response.json() as ICoinListItem[];
|
||||
|
||||
// Build mapping: symbol -> id
|
||||
for (const coin of coinList) {
|
||||
const symbol = coin.symbol.toLowerCase();
|
||||
const id = coin.id.toLowerCase();
|
||||
|
||||
// Don't overwrite priority mappings or existing cache entries
|
||||
if (!this.priorityTickerMap.has(symbol) && !this.coinMapCache.has(symbol)) {
|
||||
this.coinMapCache.set(symbol, id);
|
||||
}
|
||||
// Always cache the ID mapping
|
||||
this.coinMapCache.set(id, id);
|
||||
}
|
||||
|
||||
this.coinListLoadedAt = new Date();
|
||||
this.logger.info(`Loaded ${coinList.length} coins from CoinGecko`);
|
||||
} catch (error) {
|
||||
this.logger.error('Failed to load coin list from CoinGecko:', error);
|
||||
// Don't throw - we can still work with direct IDs
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Map CoinGecko simple/price response to IStockPrice
|
||||
*/
|
||||
private mapToStockPrice(
|
||||
ticker: string,
|
||||
coinId: string,
|
||||
data: any,
|
||||
dataType: 'live' | 'eod' | 'intraday'
|
||||
): IStockPrice {
|
||||
const price = data.usd;
|
||||
const change24h = data.usd_24h_change || 0;
|
||||
|
||||
// Calculate previous close from 24h change
|
||||
const changePercent = change24h;
|
||||
const change = (price * changePercent) / 100;
|
||||
const previousClose = price - change;
|
||||
|
||||
// Parse last updated timestamp
|
||||
const timestamp = data.last_updated_at
|
||||
? new Date(data.last_updated_at * 1000)
|
||||
: new Date();
|
||||
|
||||
return {
|
||||
ticker: ticker.toUpperCase(),
|
||||
price: price,
|
||||
currency: 'USD',
|
||||
change: change,
|
||||
changePercent: changePercent,
|
||||
previousClose: previousClose,
|
||||
timestamp: timestamp,
|
||||
provider: this.name,
|
||||
marketState: 'REGULAR', // Crypto markets are 24/7
|
||||
|
||||
// Volume and market cap
|
||||
volume: data.usd_24h_vol,
|
||||
|
||||
dataType: dataType,
|
||||
fetchedAt: new Date(),
|
||||
|
||||
// Company identification (use coin name)
|
||||
companyName: coinId.charAt(0).toUpperCase() + coinId.slice(1),
|
||||
companyFullName: `${coinId.charAt(0).toUpperCase() + coinId.slice(1)} (${ticker.toUpperCase()})`
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Build HTTP headers with optional API key
|
||||
*/
|
||||
private buildHeaders(): Record<string, string> {
|
||||
const headers: Record<string, string> = {
|
||||
'Accept': 'application/json'
|
||||
};
|
||||
|
||||
if (this.apiKey) {
|
||||
// Use Demo or Pro API key header
|
||||
// CoinGecko accepts both x-cg-demo-api-key and x-cg-pro-api-key
|
||||
headers['x-cg-demo-api-key'] = this.apiKey;
|
||||
}
|
||||
|
||||
return headers;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if response indicates a rate limit error (429)
|
||||
*/
|
||||
private isRateLimitError(responseData: any): boolean {
|
||||
return responseData?.status?.error_code === 429;
|
||||
}
|
||||
|
||||
/**
|
||||
* Wrapper for fetch operations with automatic rate limit retry and exponential backoff
|
||||
*/
|
||||
private async fetchWithRateLimitRetry<T>(
|
||||
fetchFn: () => Promise<T>,
|
||||
operationName: string,
|
||||
maxRetries: number = 3
|
||||
): Promise<T> {
|
||||
let lastError: Error | undefined;
|
||||
|
||||
for (let attempt = 0; attempt < maxRetries; attempt++) {
|
||||
try {
|
||||
const result = await fetchFn();
|
||||
this.rateLimiter.resetErrors();
|
||||
return result;
|
||||
} catch (error) {
|
||||
lastError = error as Error;
|
||||
|
||||
if (error instanceof RateLimitError) {
|
||||
const attemptInfo = `${attempt + 1}/${maxRetries}`;
|
||||
this.logger.warn(
|
||||
`Rate limit hit for ${operationName}, waiting ${error.waitTime}ms before retry ${attemptInfo}`
|
||||
);
|
||||
|
||||
if (attempt < maxRetries - 1) {
|
||||
await plugins.smartdelay.delayFor(error.waitTime);
|
||||
continue;
|
||||
} else {
|
||||
this.logger.error(`Max retries (${maxRetries}) exceeded for ${operationName} due to rate limiting`);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
// Non-rate-limit errors: throw immediately
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
throw lastError!;
|
||||
}
|
||||
}
|
||||
@@ -217,6 +217,7 @@ export class SecEdgarProvider implements IFundamentalsProvider {
|
||||
/**
|
||||
* Fetch the SEC ticker-to-CIK mapping list
|
||||
* Cached for 24 hours (list updates daily)
|
||||
* Uses native fetch for automatic gzip decompression
|
||||
*/
|
||||
private async fetchTickerList(): Promise<any> {
|
||||
// Check cache
|
||||
@@ -230,29 +231,44 @@ export class SecEdgarProvider implements IFundamentalsProvider {
|
||||
// Wait for rate limit slot
|
||||
await this.rateLimiter.waitForSlot();
|
||||
|
||||
// Fetch from SEC
|
||||
const response = await plugins.smartrequest.SmartRequest.create()
|
||||
.url(this.tickersUrl)
|
||||
.headers({
|
||||
'User-Agent': this.userAgent,
|
||||
'Accept': 'application/json'
|
||||
})
|
||||
.timeout(this.config.timeout)
|
||||
.get();
|
||||
// Fetch from SEC using native fetch (handles gzip automatically)
|
||||
const controller = new AbortController();
|
||||
const timeoutId = setTimeout(() => controller.abort(), this.config.timeout);
|
||||
|
||||
const data = await response.json();
|
||||
try {
|
||||
const response = await fetch(this.tickersUrl, {
|
||||
headers: {
|
||||
'User-Agent': this.userAgent,
|
||||
'Accept': 'application/json'
|
||||
// Note: Accept-Encoding is set automatically by fetch
|
||||
},
|
||||
signal: controller.signal
|
||||
});
|
||||
|
||||
// Cache the list
|
||||
this.tickerListCache = {
|
||||
data,
|
||||
timestamp: new Date()
|
||||
};
|
||||
clearTimeout(timeoutId);
|
||||
|
||||
return data;
|
||||
if (!response.ok) {
|
||||
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
|
||||
}
|
||||
|
||||
const data = await response.json();
|
||||
|
||||
// Cache the list
|
||||
this.tickerListCache = {
|
||||
data,
|
||||
timestamp: new Date()
|
||||
};
|
||||
|
||||
return data;
|
||||
} catch (error) {
|
||||
clearTimeout(timeoutId);
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch company facts from SEC EDGAR
|
||||
* Uses native fetch for automatic gzip decompression
|
||||
*/
|
||||
private async fetchCompanyFacts(cik: string): Promise<any> {
|
||||
// Pad CIK to 10 digits
|
||||
@@ -262,26 +278,39 @@ export class SecEdgarProvider implements IFundamentalsProvider {
|
||||
// Wait for rate limit slot
|
||||
await this.rateLimiter.waitForSlot();
|
||||
|
||||
// Fetch from SEC
|
||||
const response = await plugins.smartrequest.SmartRequest.create()
|
||||
.url(url)
|
||||
.headers({
|
||||
'User-Agent': this.userAgent,
|
||||
'Accept': 'application/json',
|
||||
'Accept-Encoding': 'gzip, deflate',
|
||||
'Host': 'data.sec.gov'
|
||||
})
|
||||
.timeout(this.config.timeout)
|
||||
.get();
|
||||
// Fetch from SEC using native fetch (handles gzip automatically)
|
||||
const controller = new AbortController();
|
||||
const timeoutId = setTimeout(() => controller.abort(), this.config.timeout);
|
||||
|
||||
const data = await response.json();
|
||||
try {
|
||||
const response = await fetch(url, {
|
||||
headers: {
|
||||
'User-Agent': this.userAgent,
|
||||
'Accept': 'application/json',
|
||||
'Host': 'data.sec.gov'
|
||||
// Note: Accept-Encoding is set automatically by fetch and gzip is handled transparently
|
||||
},
|
||||
signal: controller.signal
|
||||
});
|
||||
|
||||
// Validate response
|
||||
if (!data || !data.facts) {
|
||||
throw new Error('Invalid response from SEC EDGAR API');
|
||||
clearTimeout(timeoutId);
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
|
||||
}
|
||||
|
||||
const data = await response.json();
|
||||
|
||||
// Validate response
|
||||
if (!data || !data.facts) {
|
||||
throw new Error('Invalid response from SEC EDGAR API');
|
||||
}
|
||||
|
||||
return data;
|
||||
} catch (error) {
|
||||
clearTimeout(timeoutId);
|
||||
throw error;
|
||||
}
|
||||
|
||||
return data;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -382,20 +411,29 @@ export class SecEdgarProvider implements IFundamentalsProvider {
|
||||
|
||||
/**
|
||||
* Check if SEC EDGAR API is available
|
||||
* Uses native fetch for automatic gzip decompression
|
||||
*/
|
||||
public async isAvailable(): Promise<boolean> {
|
||||
try {
|
||||
// Test with Apple's well-known CIK
|
||||
const url = `${this.baseUrl}/companyfacts/CIK0000320193.json`;
|
||||
|
||||
const response = await plugins.smartrequest.SmartRequest.create()
|
||||
.url(url)
|
||||
.headers({
|
||||
const controller = new AbortController();
|
||||
const timeoutId = setTimeout(() => controller.abort(), 5000);
|
||||
|
||||
const response = await fetch(url, {
|
||||
headers: {
|
||||
'User-Agent': this.userAgent,
|
||||
'Accept': 'application/json'
|
||||
})
|
||||
.timeout(5000)
|
||||
.get();
|
||||
},
|
||||
signal: controller.signal
|
||||
});
|
||||
|
||||
clearTimeout(timeoutId);
|
||||
|
||||
if (!response.ok) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const data = await response.json();
|
||||
return data && data.facts !== undefined;
|
||||
|
||||
Reference in New Issue
Block a user