Documentation source for docs.vectrade.io, built with Mintlify.
# Install Mintlify CLI
npm i -g mintlify
# Run locally (hot-reload at http://localhost:3000)
mintlify dev├── mint.json # Mintlify configuration & navigation
├── favicon.svg # Site favicon
├── logo/
│ ├── dark.svg # Logo for dark mode
│ └── light.svg # Logo for light mode
├── openapi/
│ └── spec.yaml # OpenAPI 3.1 spec (27 endpoints)
├── introduction.mdx # Landing page
├── quickstart.mdx # Getting started (5 min)
├── guides/
│ ├── authentication.mdx # API key management
│ ├── error-handling.mdx # Error types & retry logic
│ ├── streaming.mdx # SSE streaming
│ ├── rate-limits.mdx # Quotas & optimization
│ └── webhooks.mdx # Event delivery & HMAC
├── sdks/
│ ├── python.mdx # Python SDK reference
│ ├── typescript.mdx # TypeScript SDK reference
│ ├── cli.mdx # CLI reference
│ ├── finkit.mdx # FinKit (open-source library)
│ ├── mcp.mdx # MCP server for AI IDEs
│ └── ai-provider.mdx # Vercel AI SDK provider
├── api-reference/
│ ├── overview.mdx # API reference landing page
│ ├── quotes/ # Quote endpoints
│ ├── fundamentals/ # Fundamentals endpoints
│ ├── technicals/ # Technicals endpoints
│ ├── news/ # News endpoints
│ ├── screener/ # Screener endpoints
│ ├── ai/ # AI analysis endpoints
│ ├── analyst/ # Analyst endpoints
│ ├── earnings/ # Earnings endpoints
│ ├── insider/ # Insider endpoints
│ ├── options/ # Options endpoints
│ ├── webhooks/ # Webhook endpoints
│ └── developer/ # Developer/key management endpoints
└── scripts/
└── check-links.mjs # Internal link validator
# Check all page references in mint.json exist
node scripts/check-links.mjs
# Validate frontmatter exists on all .mdx files
for f in $(find . -name "*.mdx" -not -path "./node_modules/*"); do
head -1 "$f" | grep -q "^---" || echo "Missing frontmatter: $f"
done- Keep explanations concise — developers scan docs
- Always include multi-language code examples (Python, TypeScript, CLI)
- Use
<CodeGroup>for language tabs - Verify all code examples compile/run correctly
- Never include real API keys — use
vq_test_...placeholders
| Repository | Description | Docs Page |
|---|---|---|
| vectrade-python | Python SDK | /sdks/python |
| vectrade-node | TypeScript SDK | /sdks/typescript |
| vectrade-cli | Go CLI | /sdks/cli |
| vectrade-ai-provider | Vercel AI SDK provider | /sdks/ai-provider |
| vectrade-mcp | MCP server for AI IDEs | /sdks/mcp |
| finkit | Financial computations | /sdks/finkit |
| vectrade-openapi | OpenAPI spec | /api-reference |
| vectrade-examples | Runnable examples | — |
| vectrade-sdk-generator | SDK code generator | — |
| homebrew-vectrade | Homebrew tap | — |
| scoop-vectrade | Scoop bucket (Windows) | — |
| awesome-vectrade | Community resources | — |
| .github | Org-level governance | — |
See CONTRIBUTING.md for writing guidelines and local setup.
Apache-2.0 — see LICENSE.