FinanceQuery is an open-source API for financial data that provides real-time quotes, market data, news, and technical indicators. It sources data from the unofficial Yahoo Finance API, web scraping, and other financial data providers.
Clone the project
git clone https://github.com/Verdenroz/finance-query.gitGo to the project directory
cd finance-queryInstall dependencies
# Using Poetry (recommended)
poetry install
# Using pip
pip install -r requirements.txtCythonize files
python setup.py build_ext --inplaceStart the server
python -m uvicorn src.main:app --reloadThe exposed endpoints to the API are:
An x-api-key header can be added if you have enabled security and rate limiting. If a key is not provided, or an
invalid key is used, a rate limit of 2000 requests/day is applied to the request's ip address.
If you are deploying this for yourself, you can create your own admin key which will not be rate limited. See the .env template.
# Get detailed quote for NVIDIA stock
curl -X GET 'https://finance-query.onrender.com/v1/quotes?symbols=nvda' \
-H 'x-api-key: your-api-key'[
{
"symbol": "NVDA",
"name": "NVIDIA Corporation",
"price": "120.15",
"afterHoursPrice": "121.60",
"change": "-11.13",
"percentChange": "-8.48%",
"open": "135.00",
"high": "135.00",
"low": "120.01",
"yearHigh": "153.13",
"yearLow": "75.61",
"volume": 432855617,
"avgVolume": 238908833,
"marketCap": "2.94T",
"pe": "40.87",
"dividend": "0.04",
"yield": "0.03%",
"exDividend": "Mar 12, 2025",
"earningsDate": "May 20, 2025 - May 26, 2025",
"lastDividend": "0.01",
"sector": "Technology",
"industry": "Semiconductors",
"about": "NVIDIA Corporation provides graphics and compute and networking solutions in the United States, Taiwan, China, Hong Kong, and internationally. The Graphics segment offers GeForce GPUs for gaming and PCs, the GeForce NOW game streaming service and related infrastructure, and solutions for gaming platforms; Quadro/NVIDIA RTX GPUs for enterprise workstation graphics; virtual GPU or vGPU software for cloud-based visual and virtual computing; automotive platforms for infotainment systems; and Omniverse software for building and operating metaverse and 3D internet applications. The Compute & Networking segment comprises Data Center computing platforms and end-to-end networking platforms, including Quantum for InfiniBand and Spectrum for Ethernet; NVIDIA DRIVE automated-driving platform and automotive development agreements; Jetson robotics and other embedded platforms; NVIDIA AI Enterprise and other software; and DGX Cloud software and services. The company's products are used in gaming, professional visualization, data center, and automotive markets. It sells its products to original equipment manufacturers, original device manufacturers, system integrators and distributors, independent software vendors, cloud service providers, consumer internet companies, add-in board manufacturers, distributors, automotive manufacturers and tier-1 automotive suppliers, and other ecosystem participants. It has a strategic collaboration with IQVIA to help realize the potential of AI in healthcare and life sciences. NVIDIA Corporation was incorporated in 1993 and is headquartered in Santa Clara, California.",
"fiveDaysReturn": "-14.25%",
"oneMonthReturn": "1.46%",
"threeMonthReturn": "-11.22%",
"sixMonthReturn": "-6.35%",
"ytdReturn": "-10.53%",
"yearReturn": "52.67%",
"threeYearReturn": "397.37%",
"fiveYearReturn": "1,802.61%",
"tenYearReturn": "21,686.04%",
"maxReturn": "274,528.59%",
"logo": "https://img.logo.dev/nvidia.com?token=pk_Xd1Cdye3QYmCOXzcvxhxyw&retina=true"
}
]// Connect to WebSocket for real-time updates
const ws = new WebSocket('wss://finance-query.onrender.com/quotes');
ws.onopen = () => {
console.log('Connected to FinanceQuery WebSocket');
// Send symbol to subscribe to updates
ws.send('TSLA');
};
ws.onmessage = (event) => {
const data = JSON.parse(event.data);
console.log('Real-time update:', data);
};[
{
"symbol": "TSLA",
"name": "Tesla, Inc.",
"price": "398.09",
"change": "+0.94",
"percentChange": "+0.24%",
"logo": "https://img.logo.dev/tesla.com?token=pk_Xd1Cdye3QYmCOXzcvxhxyw&retina=true"
}
]| Endpoint | Description |
|---|---|
/health, /ping |
API status and health monitoring |
/hours |
Trading hours and market status |
/v1/quotes |
Detailed quotes and information |
/v1/simple-quotes |
Simplified quotes with summary information |
/v1/similar |
Find similar quotes to queried symbol |
/v1/historical |
Historical price data with customizable ranges |
/v1/movers |
Market gainers, losers, and most active stocks |
/v1/news |
Financial news and market updates |
/v1/indices |
Major market indices (S&P 500, NASDAQ, DOW) |
/v1/sectors |
Market sector performance and analysis |
/v1/search |
Search for securities with filters |
/v1/indicator |
Get specific indicator history over time |
/v1/indicators |
Technical indicators summary for interval |
/v1/stream |
SSE for real-time quote updates |
| Endpoint | Description |
|---|---|
/quotes |
Real-time quotes updates |
/profile |
Real-time detailed ticker updates (quote, news, similar) |
/market |
Real-time market updates (indices, news, movers, sectors) |
/hours |
Real-time market hour updates |
Perfect for serverless applications with automatic scaling:
- Follow the AWS Lambda Deployment Guide
- Remember to add the environment variables to the Lambda function
- Alternatively use the AWS Deployment Workflow, providing repository secrets for
AWS_SECRET_IDandAWS_SECRET_KEY. - Also edit the
AWS_REGION,ECR_REPOSITORY, andFUNCTION_NAMEin the workflow file
Easy deployment with WebSocket support:
- Follow the Render Deployment Guide
- The deployment should use the
Dockerfilefile in the repository - Be sure to override the CMD in the Dockerfile in your Render project settings to
python -m uvicorn src.main:app --host 0.0.0.0 --port $PORT - Alternatively use the Render Deployment Workflow, providing repository secrets
for
RENDER_DEPLOY_HOOK_URL. - The deploy hook url can be found in the settings of your Render project
Deploy anywhere with Docker:
docker build -t financequery .
docker run -p 8000:8000 financequeryNote: There are two workflows that will automatically deploy to render and AWS, but they will require repository secrets for
AWS_SECRET_ID,AWS_SECRET_KEY, andRENDER_DEPLOY_HOOK_URL. Quite frankly, render is easier to work with since it enables the websockets, but will require the paid Starter Plan as this API requires extensive memory. If you are tight on cash, consider Lambda.
WebSocket Support: Remember the websockets above are not available through Lambda. If you deploy to Render instead, you will be able to connect to the websockets through a request that looks like
wss://finance-query.onrender.com/...
Customize FinanceQuery with environment variables. These environment variables are optional. The API will function with default settings if not provided.
USE_SECURITY=true
ADMIN_API_KEY=your-secret-admin-keyUSE_PROXY=true
PROXY_URL=your-proxy-url
PROXY_TOKEN=your-proxy-tokenREDIS_URL=redis://localhost:6379ALGOLIA_APP_ID=your-algolia-app-id
ALGOLIA_API_KEY=your-algolia-api-keyFinanceQuery leverages:
- FastAPI for lightning-fast HTTP performance
- fastapi-injectable for efficient dependency injection
- curl_cffi for async browser curl impersonation
- lxml for fast and reliable web scraping
- Cython for accelerated technical indicator calculations
- Redis for intelligent caching of market data
- logo.dev for fetching stock logos
This project is licensed under the terms of the MIT License.
Need Help?
- 📧 Email: harveytseng2@gmail.com
- 🐛 Issues: GitHub Issues
- 📖 OpenAPI Documentation: OpenAPI Documentation
As most data is scraped, some endpoints may break. If something is not working or if you have any suggestions, please reach out!