> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vectrade.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> VecTrade is a virtual trading platform with free developer APIs, AI copilot, and SDKs for Python, TypeScript, Go, and AI-native integrations.

# Welcome to VecTrade

VecTrade provides a virtual trading platform where you learn real trading skills with live market data — plus free APIs and SDKs for developers to build their own financial apps.

<Info>
  **New here?** Follow the [Quickstart Guide](/quickstart) to make your first API call in under 2 minutes.
</Info>

## What You Can Build

<CardGroup cols={2}>
  <Card title="Trading Bots" icon="robot">
    Build automated trading strategies with real-time quotes, technical indicators, and AI analysis.
  </Card>

  <Card title="Portfolio Dashboards" icon="chart-line">
    Create beautiful dashboards with live data, fundamentals, and risk metrics.
  </Card>

  <Card title="AI Agents" icon="brain">
    Power financial AI agents with structured data and streaming analysis via MCP or Vercel AI SDK. AI agents can [trade autonomously](/guides/bot-trading) with the Bot API.
  </Card>

  <Card title="Screening Tools" icon="filter">
    Build custom screeners with fundamental filters, technical signals, and sentiment data.
  </Card>
</CardGroup>

## Platform at a Glance

| Feature             | Details                                                                            |
| ------------------- | ---------------------------------------------------------------------------------- |
| **Endpoints**       | See the API Reference and OpenAPI spec for the current endpoint surface            |
| **Bot Trading API** | Trade via `X-Bot-Key` with account/portfolio/order/KPI endpoints                   |
| **Coverage**        | 100K+ global instruments (equities, ETFs, indices)                                 |
| **Latency**         | Sub-100ms p95 response time                                                        |
| **Streaming**       | Server-Sent Events for AI copilot                                                  |
| **SDKs**            | Python, TypeScript, Go CLI, Vercel AI, MCP                                         |
| **Auth**            | X-API-Key header (Authorization bearer may be accepted in some direct deployments) |
| **Rate Limits**     | 30–300 req/min depending on plan                                                   |
| **Environments**    | Production and UAT                                                                 |

## Choose Your SDK

<CardGroup cols={3}>
  <Card title="Python" icon="python" href="/sdks/python">
    `pip install vectrade`
  </Card>

  <Card title="TypeScript" icon="js" href="/sdks/typescript">
    `npm install @vectrade/sdk`
  </Card>

  <Card title="Go CLI" icon="terminal" href="/sdks/cli">
    `brew install VecTrade-io/vectrade/vectrade`
  </Card>
</CardGroup>

## Quick Example

<CodeGroup>
  ```python Python theme={null}
  from vectrade import VecTrade

  client = VecTrade()  # uses VECTRADE_API_KEY env var
  quote = client.quotes.get("AAPL")
  print(f"{quote.symbol}: ${quote.price} ({quote.change_pct:+.2f}%)")
  ```

  ```typescript TypeScript theme={null}
  import { VecTrade } from '@vectrade/sdk';

  const client = new VecTrade();
  const quote = await client.quotes.get('AAPL');
  console.log(`${quote.ticker}: $${quote.price} (${quote.change_percent}%)`);
  ```

  ```bash CLI theme={null}
  vectrade quote AAPL
  ```

  ```bash cURL theme={null}
  curl -H "X-API-Key: $VECTRADE_API_KEY" \
    https://api.vectrade.io/v1/vq/quotes/AAPL
  ```
</CodeGroup>

## Key Features

| Feature              | Description                                                           |
| -------------------- | --------------------------------------------------------------------- |
| **Real-time Quotes** | Sub-second market data for 100K+ instruments                          |
| **Fundamentals**     | Income statements, balance sheets, ratios, and company profiles       |
| **Company Profiles** | Sector, industry, exchange, and corporate details                     |
| **Technicals**       | 50+ indicators (RSI, MACD, Bollinger, etc.) with configurable periods |
| **Sentiment**        | Social & news sentiment scoring with directional signals              |
| **Historical Data**  | OHLCV price history with configurable periods                         |
| **Options**          | Full chains with Greeks, IV, and expiration data                      |
| **Analyst Data**     | Wall Street consensus, price targets, and rating history              |
| **Earnings**         | EPS history, beat/miss records, and upcoming dates                    |
| **ETF Data**         | NAV, holdings count, expense ratios for ETF instruments               |

## Open Source

The entire VecTrade ecosystem is open source under the [VecTrade-io](https://github.com/VecTrade-io) GitHub organization. See the [Ecosystem](/ecosystem) page for the full architecture and project map.

| Repo                                                                        | Purpose                                           |
| --------------------------------------------------------------------------- | ------------------------------------------------- |
| [vectrade-python](https://github.com/VecTrade-io/vectrade-python)           | Python SDK (async, typed, streaming)              |
| [vectrade-node](https://github.com/VecTrade-io/vectrade-node)               | TypeScript SDK (zero-dep, edge-ready)             |
| [vectrade-cli](https://github.com/VecTrade-io/vectrade-cli)                 | Go CLI with OAuth and shell completions           |
| [vectrade-ai-provider](https://github.com/VecTrade-io/vectrade-ai-provider) | Vercel AI SDK tool provider                       |
| [vectrade-mcp](https://github.com/VecTrade-io/vectrade-mcp)                 | Model Context Protocol server (16 tools)          |
| [finkit](https://github.com/VecTrade-io/finkit)                             | Financial analytics (indicators, risk, screening) |
| [vectrade-openapi](https://github.com/VecTrade-io/vectrade-openapi)         | OpenAPI 3.1 specification                         |
| [vectrade-examples](https://github.com/VecTrade-io/vectrade-examples)       | Runnable examples and templates                   |

## Getting Started

1. [Create an account](https://vectrade.io/register) and get your API key
2. Install your preferred SDK
3. Follow the [Quickstart Guide](/quickstart)
4. Explore the [API Reference](/api-reference/overview)
5. Build a trading bot with the [Bot Trading Guide](/guides/bot-trading)