@vectrade/ai-provider

VecTrade provider for Vercel AI SDK — use financial AI tools in any AI framework.

Installation

npm install @vectrade/ai-provider ai

Quick Start

import { createVecTrade } from "@vectrade/ai-provider";
import { generateText } from "ai";

const vt = createVecTrade({ apiKey: process.env.VECTRADE_API_KEY });

const { text } = await generateText({
  model: yourModel,
  tools: vt.tools(),
  prompt: "What's AAPL trading at and what do analysts think?",
});

Configuration

import { createVecTrade } from "@vectrade/ai-provider";

const vt = createVecTrade({
  // Required: API key (or set VECTRADE_API_KEY env var)
  apiKey: "vq_live_...",

  // Optional: custom base URL (default: https://api.vectrade.io/v1)
  baseURL: "https://api.vectrade.io/v1",

  // Optional: request timeout in ms (default: 30000)
  timeout: 30_000,
});

Available Tools

The provider exposes 14 financial AI tools that integrate seamlessly with the Vercel AI SDK:

Market Data

| Tool | Description | |------|-------------| | getQuote | Real-time stock quote for a ticker | | getBatchQuotes | Quotes for multiple symbols (max 50) |

Fundamentals

| Tool | Description | |------|-------------| | getFundamentals | PE ratio, market cap, financials overview | | getIncomeStatement | Revenue, earnings, margins (annual/quarterly) | | getBalanceSheet | Assets, liabilities, equity (annual/quarterly) |

Technical Analysis

| Tool | Description | |------|-------------| | getTechnicals | RSI, MACD, Bollinger Bands, etc. |

News & Sentiment

| Tool | Description | |------|-------------| | getNews | Latest financial news, filterable by symbol | | getAnalystRatings | Consensus ratings and price targets |

AI Analysis

| Tool | Description | |------|-------------| | analyzeStock | AI-powered stock analysis | | compareStocks | Side-by-side stock comparison |

Screening

| Tool | Description | |------|-------------| | runScreener | Filter stocks by custom criteria |

Options & Events

| Tool | Description | |------|-------------| | getOptionsChain | Options chain by expiration | | getEarnings | Earnings history and estimates | | getInsiderTransactions | Insider buying/selling activity |

Usage Patterns

Use All Tools

const { text } = await generateText({
  model: yourModel,
  tools: vt.tools(),
  prompt: "Analyze the tech sector",
});

Use Individual Tools

const quote = await vt.getQuote.execute(
  { symbol: "AAPL" },
  { toolCallId: "id", messages: [] },
);

Streaming

import { streamText } from "ai";

const stream = streamText({
  model: yourModel,
  tools: vt.tools(),
  prompt: "Give me a portfolio analysis",
});

for await (const chunk of stream.textStream) {
  process.stdout.write(chunk);
}

Requirements

• Node.js 18+ (uses native fetch)
• VecTrade API key — get one at vectrade.io
• ai package (Vercel AI SDK) as peer dependency

Part of the VecTrade Ecosystem

| Package | Description | |---------|-------------| | vectrade | Python SDK for VecTrade API | | @vectrade/sdk | TypeScript/Node SDK | | vectrade-finkit | Financial computation library | | @vectrade/ai-provider | Vercel AI SDK provider (this package) | | @vectrade/mcp | Model Context Protocol server |

Documentation

Full documentation is available at docs.vectrade.io/sdks/ai-provider.

Contributing

See CONTRIBUTING.md for development setup and guidelines.

License

MIT — see LICENSE.