https://github.com/milojebtc/financial-ai-agent-public
https://github.com/milojebtc/financial-ai-agent-public
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/milojebtc/financial-ai-agent-public
- Owner: milojeBtc
- License: other
- Created: 2025-01-27T03:18:20.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-01-27T03:21:11.000Z (9 months ago)
- Last Synced: 2025-01-27T04:23:32.006Z (9 months ago)
- Language: TypeScript
- Size: 1.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AI Financial Agent 🤖
This is a proof of conncept AI financial agent. The goal of this project is to explore the use of AI for investment research. This project is for **educational** purposes only and is not intended for real trading or investment.
👋 **Demo**: You can use a live demo of this project [here](https://chat.financialdatasets.ai/).
## Disclaimer
This project is for **educational and research purposes only**.
- Not intended for real trading or investment
- No warranties or guarantees provided
- Past performance does not indicate future results
- Creator assumes no liability for financial losses
- Consult a financial advisor for investment decisions
By using this software, you agree to use it solely for learning purposes.
## Table of Contents 📖
- [Features](#features)
- [Setup](#setup)
- [Usage](#usage)
- [Financial Data](#financial-data)
- [Deploy Your Own](#deploy-your-own)
## Features 🌟
- [AI SDK](https://sdk.vercel.ai/docs)
- Unified API for generating text, structured objects, and tool calls with LLMs
- Hooks for building dynamic chat and generative user interfaces
- Supports OpenAI (default), Anthropic, Cohere, and other model providers
- [Financial Datasets API](https://financialdatasets.ai)
- Access to real-time and historical stock market data
- Data is optimized for AI financial agents
- 30+ years of financial data with 100% market coverage
- Documentation available [here](https://docs.financialdatasets.ai)
- [shadcn/ui](https://ui.shadcn.com)
- Styling with [Tailwind CSS](https://tailwindcss.com)
- Component primitives from [Radix UI](https://radix-ui.com) for accessibility and flexibility
## Setup 🛠️
```bash
git clone https://github.com/virattt/ai-financial-agent.git
cd ai-financial-agent
```
> If you do not have npm installed, please install it from [here](https://nodejs.org/en/download/).
1. Install pnpm (if not already installed):
```bash
npm install -g pnpm
```
2. Install dependencies:
```bash
pnpm install
```
3. Set up your environment variables:
```bash
# Create .env file for your API keys
cp .env.example .env
```
Set the API keys in the .env file:
```
# Get your OpenAI API key from https://platform.openai.com/
OPENAI_API_KEY=your-openai-api-key
# Get your Financial Datasets API key from https://financialdatasets.ai/
FINANCIAL_DATASETS_API_KEY=your-financial-datasets-api-key
# Get your LangSmith API key from https://smith.langchain.com/
LANGCHAIN_API_KEY=your-langsmith-api-key
LANGCHAIN_TRACING_V2=true
LANGCHAIN_PROJECT=ai-financial-agent
```
> Note: You should not commit your `.env` file or it will expose secrets that will allow others to control access to your various OpenAI and authentication provider accounts.
If you want to deploy your own version of the AI Financial Agent in production, you need to link your local instance with your Vercel and GitHub accounts.
1. Install Vercel CLI: `npm i -g vercel`
2. Link local instance with Vercel and GitHub accounts (creates `.vercel` directory): `vercel link`
3. Download your environment variables: `vercel env pull`
## Usage 🎮
After completing the steps above, simply run the following command to start the development server:
```bash
pnpm dev
```
Your app template should now be running on [localhost:3000](http://localhost:3000/).
## Financial Data
This template uses the [Financial Datasets API](https://financialdatasets.ai) as the financial data provider. The Financial Datasets API is specifically designed for AI financial agents and LLMs.
The Financial Datasets API provides real-time and historical stock market data and covers 100% of the US market over the past 30 years.
Data includes financial statements, stock prices, options data, insider trades, institutional ownership, and much more. You can learn more about the API via the documentation [here](https://docs.financialdatasets.ai).
> Note: Data is free for AAPL, GOOGL, MSFT, NVDA, and TSLA.
If you do not want to use the Financial Datasets API, you can easily switch to another data provider by modifying a few lines of code.
## Deploy Your Own 🚀
You can deploy your own version of the AI Financial Agent in production via Vercel with one click: