@stockai/sdk

Official SDK for the StockAI Pro API.

Installation

npm install @stockai/sdk
# or
pnpm add @stockai/sdk
# or
yarn add @stockai/sdk

Usage

import { StockAIClient } from '@stockai/sdk';

// Initialize client
const client = new StockAIClient({
  baseUrl: 'https://api.stockai.pro',
  apiKey: 'your-api-key', // Optional, for authenticated requests
});

// Get stock quote
const stock = await client.stocks.get('AAPL');
console.log(stock.quote?.price);

// Search stocks
const results = await client.stocks.search('apple');

// Get price history
const history = await client.stocks.getHistory('AAPL', { period: '1y' });

// Run AI analysis
const analysis = await client.analysis.run('AAPL');
console.log(analysis.consensus); // 'BUY' | 'SELL' | 'HOLD' | null

// Get cached analysis
const cached = await client.analysis.get('AAPL');

// Get crypto price
const btc = await client.crypto.get('BTC-USD');

Authenticated Endpoints

For authenticated endpoints (alerts, watchlist), provide an API key:

const client = new StockAIClient({
  baseUrl: 'https://api.stockai.pro',
  apiKey: process.env.STOCKAI_API_KEY,
});

// Watchlist
const watchlist = await client.watchlist.list();
await client.watchlist.add('AAPL');
await client.watchlist.remove('AAPL');

// Alerts
const alerts = await client.alerts.list();
await client.alerts.create({ symbol: 'AAPL', type: 'CONSENSUS_BUY' });
await client.alerts.updatePreferences({
  emailAlerts: true,
  minConfidenceScore: 80,
});

TypeScript Types

All types are exported for use in your application:

import type {
  StockQuote,
  AnalysisResult,
  ModelResponse,
  Rating,
  Alert,
  CryptoPrice,
} from '@stockai/sdk';

Configuration Options

const client = new StockAIClient({
  baseUrl: 'https://api.stockai.pro', // Required
  apiKey: 'your-api-key',             // Optional
  timeout: 30000,                     // Optional, default 30s
});

Error Handling

try {
  const analysis = await client.analysis.run('INVALID');
} catch (error) {
  console.error('Analysis failed:', error.message);
}

License

MIT