patrickstigler/py-stocks-api

PY-Stocks

镜像概述和主要用途

PY-Stocks是一个基于yfinance库的轻量级数据API服务，提供简洁的RESTful接口。它封装了yfinance的核心功能，简化了历史数据下载和公司信息查询流程，适合开发者快速集成到***分析工具、***应用或数据可视化项目中，无需直接处理yfinance库的复杂性。

核心功能和特性

• 历史数据下载：通过/download端点获取指定代码在特定日期范围内的历史交易数据（开盘价、最高价、最低价、收盘价、成交量等）
• 公司信息查询：通过/info端点获取公司基本信息、财务指标及实时股价
• 轻量级架构：基于Flask和gunicorn构建，资源占用低，部署简单
• 灵活参数配置：支持自定义数据时间间隔（默认1天）

使用场景和适用范围

• ***数据分析工具开发
• 个人***分析应用
• ***数据可视化项目
• 快速原型开发中的***数据获取需求

使用方法和配置说明

构建和运行镜像

前提条件

• 已安装Git和Docker

构建步骤

bash
# 克隆仓库
git clone https://github.com/pinkahd/py-stocks

# 进入仓库目录
cd py-stocks

# 构建Docker镜像
docker build . -t py-stocks

# 运行容器（映射8000端口）
docker run -p 8000:8000 py-stocks

Docker Compose配置（可选）

yaml
version: '3'
services:
  py-stocks:
    build: .
    ports:
      - "8000:8000"
    restart: always

API端点说明

1. 下载历史数据

端点：/download/:symbol/:startDate/:endDate

功能：获取指定***代码在起始日期和结束日期之间的历史交易数据

参数说明：

• symbol：***代码（如AAPL、MSFT）
• startDate：起始日期（格式：YYYY-MM-DD）
• endDate：结束日期（格式：YYYY-MM-DD）
• interval（可选查询参数）：数据时间间隔，默认值为1d（1天）

示例请求：

bash
curl "localhost:8000/download/AAPL/2021-08-01/2021-08-03?interval=1d" | jq

响应示例：

json
{
  "Open": {
    "1627862400000": 146.3600006104
  },
  "High": {
    "1627862400000": 146.9499969482
  },
  "Low": {
    "1627862400000": 145.25
  },
  "Close": {
    "1627862400000": 145.5200042725
  },
  "Adj Close": {
    "1627862400000": 145.3023071289
  },
  "Volume": {
    "1627862400000": 62880000
  }
}

2. 获取公司信息

端点：/info/:symbol

功能：获取指定***代码对应的公司基本信息、财务指标及当前股价

参数说明：

• symbol：***代码（如AAPL、MSFT）

示例请求：

bash
curl localhost:8000/info/AAPL | jq

响应示例：

json
{
  "52WeekChange": 0.18871057,
  "SandP52WeekChange": 0.2816925,
  "address1": "One Apple Park Way",
  "city": "Cupertino",
  "country": "United States",
  "currency": "USD",
  "currentPrice": 147.54,
  "dayHigh": 149.12,
  "dayLow": 147.51,
  "dividendRate": 0.88,
  "dividendYield": 0.006,
  "industry": "Consumer Electronics",
  "longName": "Apple Inc.",
  "marketCap": 2438865616896,
  "sector": "Technology",
  "symbol": "AAPL",
  "website": "http://www.apple.com",
  "zip": "95014"
  // 完整响应包含更多财务指标和公司信息
}

依赖和Credits

本软件使用以下开源组件：

• yfinance - ***数据获取库
• gunicorn - Python WSGI HTTP服务器
• Flask - Python Web框架

许可证

PY-Stocks采用MIT许可证发布。