Back to Details

akshare-skill

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

AKShare Data API Reference

AKShare 数据API参考文档

AKShare is a Python package providing access to Chinese financial market data. This skill contains complete API documentation organized by asset class and data category.
AKShare是一款可获取中国金融市场数据的Python包。本工具包含按资产类别和数据分类整理的完整API文档。

Quick Start

快速开始

AKShare can be used via CLI wrapper or Python library.
AKShare可通过CLI封装器或Python库两种方式使用。

CLI (Recommended)

CLI（推荐方式）

bash
undefined
bash
undefined

Get stock data (JSON output is default)

获取股票数据（默认输出JSON格式）

python3 scripts/akshare_cli.py stock_zh_a_hist --symbol 000001 --start_date 20200101 --end_date 20210101
python3 scripts/akshare_cli.py stock_zh_a_hist --symbol 000001 --start_date 20200101 --end_date 20210101

Get as JSON explicitly

明确指定输出JSON格式

python3 scripts/akshare_cli.py stock_zh_a_hist --symbol 000001 --start_date 20200101 --end_date 20210101 --format json
python3 scripts/akshare_cli.py stock_zh_a_hist --symbol 000001 --start_date 20200101 --end_date 20210101 --format json

Export to CSV when needed for complex analysis

当需要进行复杂分析时，导出为CSV格式

python3 scripts/akshare_cli.py stock_zh_a_hist --symbol 000001 --start_date 20200101 --end_date 20210101 --format csv > stock_data.csv
undefined
python3 scripts/akshare_cli.py stock_zh_a_hist --symbol 000001 --start_date 20200101 --end_date 20210101 --format csv > stock_data.csv
undefined

Python Library (Legacy)

Python库（传统方式）

python
import akshare as ak

stock_df = ak.stock_zh_a_hist(symbol="000001", start_date="20200101", end_date="20210101")
print(stock_df)
python
import akshare as ak

stock_df = ak.stock_zh_a_hist(symbol="000001", start_date="20200101", end_date="20210101")
print(stock_df)

Data Categories

数据分类

All APIs below are available via CLI wrapper. See individual API docs for both CLI and Python usage:
以下所有API均可通过CLI封装器调用。如需了解CLI和Python两种方式的使用方法，请查看对应API文档：

Equities & Indices

股票与指数

  • Stock Data - A/B shares, history, daily snapshots, sector data, board listings
  • Index Data - Stock indices, index components, performance data
  • 股票数据 - A/B股、历史数据、每日快照、板块数据、上市列表
  • 指数数据 - 股票指数、指数成分股、业绩数据

Fixed Income & Rates

固定收益与利率

  • Bonds - Government bonds, corporate bonds, municipal bonds
  • Interest Rates - LPR rates, deposit/loan rates, yield curves
  • 债券 - 政府债券、公司债券、市政债券
  • 利率 - LPR利率、存贷款利率、收益率曲线

Derivatives & Futures

衍生品与期货

  • Futures - Futures contracts, open interest, delivery data
  • Options - Options contracts, Greeks, implied volatility
  • 期货 - 期货合约、持仓量、交割数据
  • 期权 - 期权合约、希腊字母、隐含波动率

Alternative Assets

另类资产

  • Funds - Public funds (mutual funds), private funds (hedge funds), fund ratings
  • QDII - Qualified Domestic Institutional Investor products
  • Commodities & Spot Trading - Commodity futures, spot market data
  • 基金 - 公募基金、私募基金、基金评级
  • QDII - 合格境内机构投资者产品
  • 大宗商品与现货交易 - 商品期货、现货市场数据

Forex & International

外汇与国际市场

  • Foreign Exchange (FX) - Currency pairs, exchange rates
  • Hong Kong/Singapore Data (QHKC) - Hong Kong stocks, Singapore data, commodity analysis
  • 外汇（FX） - 货币对、汇率
  • 香港/新加坡市场数据（QHKC） - 港股、新加坡市场数据、大宗商品分析

Macro & Economics

宏观经济

  • Macroeconomic Data - GDP, CPI, industrial production, consumer spending
  • Currency & FX Markets - Currency data, forex indicators
  • Energy Data - Oil, coal, natural gas prices and data
  • Interest Rates - Central bank rates, yield curves
  • 宏观经济数据 - GDP、CPI、工业生产、消费支出
  • 货币与外汇市场 - 货币数据、外汇指标
  • 能源数据 - 石油、煤炭、天然气价格及数据
  • 利率 - 央行利率、收益率曲线

Specialized Data

特色数据

  • Bank Data - Bank regulatory data, administrative penalties
  • Data Center (DC) - Data center services and infrastructure
  • Digital Currency - Cryptocurrency and digital asset data
  • Events & News - Market events, corporate actions, news events
  • Natural Language Processing - Text analysis, sentiment analysis
  • Technical Indicators & Tools - Technical analysis tools, indicators
  • Financial Articles - Financial research articles and reports
  • Others - Additional specialized data sources
  • 银行数据 - 银行监管数据、行政处罚
  • 数据中心（DC） - 数据中心服务与基础设施
  • 数字货币 - 加密货币与数字资产数据
  • 事件与资讯 - 市场事件、公司行动、资讯事件
  • 自然语言处理 - 文本分析、情感分析
  • 技术指标与工具 - 技术分析工具、指标
  • 金融研报 - 金融研究文章与报告
  • 其他 - 其他特色数据源

API Documentation Structure

API文档结构

Each reference file contains:
  • API name - The function name (e.g., 
    stock_zh_a_hist
    )
  • Target URL - Data source web address
  • Description - What the API provides
  • Rate limits - Data return limits per request
  • Input parameters - Function parameters with types and descriptions
  • Output parameters - DataFrame columns returned by the API
  • Code example - Working Python example
  • Data sample - Sample output rows
每份参考文档包含以下内容：
  • API名称 - 函数名称（例如：
    stock_zh_a_hist
    ）
  • 目标URL - 数据源网址
  • 描述 - API提供的内容
  • 请求限制 - 每次请求的数据返回限制
  • 输入参数 - 函数参数及类型、说明
  • 输出参数 - API返回的DataFrame列信息
  • 代码示例 - 可运行的Python示例
  • 数据示例 - 输出数据样例

Parameter Conventions

参数约定

Common parameter patterns across AKShare APIs:
  • symbol
     - Stock symbol (e.g., "000001" for SZZF)
  • start_date
    / 
    end_date
     - Date strings in format "YYYYMMDD" (e.g., "20200101")
  • period
     - Time period ("daily", "weekly", "monthly")
  • page
     / 
    limit
     - Pagination parameters for large datasets
  • Date output - Most APIs return datetime columns in format "YYYY-MM-DD HH:MM:SS"
AKShare各API的通用参数规则：
  • symbol
     - 股票代码（例如：上证指数代码"000001"）
  • start_date
    / 
    end_date
     - 日期字符串，格式为"YYYYMMDD"（例如："20200101"）
  • period
     - 时间周期（"daily"日度, "weekly"周度, "monthly"月度）
  • page
     / 
    limit
     - 大数据集的分页参数
  • 日期输出 - 多数API返回的日期时间列格式为"YYYY-MM-DD HH:MM:SS"

Multi-Part Categories

多部分分类

Some data categories have multiple sub-APIs:
  • Funds (references/fund/) - Public funds vs. private funds documentation
  • QHKC (references/qhkc/) - Hong Kong stocks, fundamentals, brokers, commodities, analysis tools
部分数据类别包含多个子API：
  • 基金（references/fund/） - 公募基金与私募基金文档
  • QHKC（references/qhkc/） - 港股、基本面数据、券商数据、大宗商品、分析工具

Finding What You Need

快速查找所需内容

By asset class: Start with the category above that matches your market focus
By function: If you know the AKShare function name, search within the corresponding reference file using grep patterns:
  • Stock functions: 
    stock_
  • Fund functions: 
    fund_
  • Futures functions: 
    futures_
    or 
    future_
  • Forex functions: 
    fx_
    or 
    exchange_
By data type: All APIs include parameter tables and examples. Look for "Input parameters" and "Output parameters" sections.
按资产类别查找：从上述与您关注市场匹配的分类开始
按功能查找：若您知道AKShare函数名称，可在对应参考文档中使用grep模式搜索：
  • 股票函数：
    stock_
  • 基金函数：
    fund_
  • 期货函数：
    futures_
    或 
    future_
  • 外汇函数：
    fx_
    或 
    exchange_
按数据类型查找：所有API均包含参数表与示例，可查看「输入参数」和「输出参数」章节

Example Usage Patterns

示例使用场景

Get historical stock data:

获取股票历史数据：

See references/stock.md - use 
stock_zh_a_hist()
function
查看references/stock.md - 使用
stock_zh_a_hist()
函数

Access futures data:

访问期货数据：

See references/futures.md - functions like 
futures_open_interest()
, 
futures_delivery()
查看references/futures.md - 函数如
futures_open_interest()
、
futures_delivery()

Query fund performance:

查询基金业绩：

See references/fund/fund_public.md for mutual funds or references/fund/fund_private.md for private funds
查看references/fund/fund_public.md获取公募基金信息，或references/fund/fund_private.md获取私募基金信息

Macroeconomic indicators:

宏观经济指标：

See references/macro.md - GDP, inflation, industrial production
查看references/macro.md - GDP、通胀、工业生产

Hong Kong/Singapore market data:

香港/新加坡市场数据：

See references/qhkc/ subdirectory for index data, fundamentals, and analysis tools
查看references/qhkc/子目录获取指数数据、基本面数据及分析工具

CLI Usage Guide

CLI使用指南

All AKShare functions are available via the CLI wrapper in 
scripts/akshare_cli.py
.
所有AKShare函数均可通过
scripts/akshare_cli.py
中的CLI封装器调用。

Output Formats

输出格式

  • --format json
    : JSON format for API integration (default)
  • --format pretty
    : Human-readable tables
  • --format csv
    : CSV format for import into Excel/databases (use when complex analysis is needed)
  • --format json
    ：JSON格式，适用于API集成（默认）
  • --format pretty
    ：易读的表格格式
  • --format csv
    ：CSV格式，可导入Excel/数据库（需复杂分析时使用）

Examples by Category

各分类示例

bash
undefined
bash
undefined

Stock data

股票数据

python3 scripts/akshare_cli.py stock_zh_a_hist --symbol 000001 --start_date 20240101 --end_date 20240110
python3 scripts/akshare_cli.py stock_zh_a_hist --symbol 000001 --start_date 20240101 --end_date 20240110

Index data

指数数据

python3 scripts/akshare_cli.py index_zh_a_hist --symbol 000001 --start_date 20240101 --end_date 20240110
python3 scripts/akshare_cli.py index_zh_a_hist --symbol 000001 --start_date 20240101 --end_date 20240110

Macro data

宏观数据

python3 scripts/akshare_cli.py macro_china_gdp --format json
python3 scripts/akshare_cli.py macro_china_gdp --format json

Bank data

银行数据

python3 scripts/akshare_cli.py bank_fjcf_table_detail --page 1 --item "分局本级"
python3 scripts/akshare_cli.py bank_fjcf_table_detail --page 1 --item "分局本级"

Export to file

导出至文件

python3 scripts/akshare_cli.py stock_zh_a_hist --symbol 000001 --start_date 20240101 --end_date 20240110 --format csv > output.csv

See [CLI_DESIGN.md](CLI_DESIGN.md) for complete CLI documentation.
python3 scripts/akshare_cli.py stock_zh_a_hist --symbol 000001 --start_date 20240101 --end_date 20240110 --format csv > output.csv

完整CLI文档请查看[CLI_DESIGN.md](CLI_DESIGN.md)。