# akshare **Repository Path**: jasonbource/akshare ## Basic Information - **Project Name**: akshare - **Description**: AkShare 是基于 Python 的开源金融数据接口库，目的是实现对股票、期货、期权、基金、债券、外汇等金融产品和另类数据从数据采集，数据清洗到数据下载的工具，满足金融数据科学 - **Primary Language**: Python - **License**: MIT - **Default Branch**: main - **Homepage**: https://www.oschina.net/p/akshare - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 71 - **Created**: 2024-03-22 - **Last Updated**: 2024-03-22 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README **AKShare VIP 交流群欢迎大家的加入，加群方式请点击[【加群】](https://zmj.xet.tech/s/28gOeh)** **相关视频教程已经发布：《AKShare-初阶-使用教学》、《AKShare-初阶-实战应用》、《AKShare-源码解析》、《开源项目巡礼》**，详情请访问[课程](https://app3rqjh1z21630.h5.xiaoeknow.com)查看更多课程信息！ **AKQuant 量化教程请访问：[利用 PyBroker 进行量化投资](https://akquant.akfamily.xyz/)** **本次发布 [AKTools](https://github.com/akfamily/aktools) 作为 AKShare 的 HTTP API 版本，突破 Python 语言的限制，欢迎各位小伙伴试用并提出更好的意见或建议！ 点击 [AKTools](https://github.com/akfamily/aktools) 查看使用指南。另外提供 [awesome-data](https://github.com/akfamily/awesome-data) 方便各位小伙伴查询各种数据源。** ![AKShare Logo](https://github.com/akfamily/akshare/blob/main/assets/images/akshare_logo.jpg) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/akshare.svg)](https://pypi.org/project/akshare/) [![PyPI](https://img.shields.io/pypi/v/akshare.svg)](https://pypi.org/project/akshare/) [![Downloads](https://pepy.tech/badge/akshare)](https://pepy.tech/project/akshare) [![Documentation Status](https://readthedocs.org/projects/akshare/badge/?version=latest)](https://akshare.readthedocs.io/?badge=latest) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![akshare](https://img.shields.io/badge/Data%20Science-AKShare-green)](https://github.com/akfamily/akshare) [![Actions Status](https://github.com/akfamily/akshare/actions/workflows/release_and_deploy.yml/badge.svg)](https://github.com/akfamily/akshare/actions) [![MIT Licence](https://img.shields.io/badge/license-MIT-blue)](https://github.com/akfamily/akshare/blob/main/LICENSE) [![](https://img.shields.io/github/forks/jindaxiang/akshare)](https://github.com/akfamily/akshare) [![](https://img.shields.io/github/stars/jindaxiang/akshare)](https://github.com/akfamily/akshare) [![](https://img.shields.io/github/issues/jindaxiang/akshare)](https://github.com/akfamily/akshare) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) ## Overview [AKShare](https://github.com/akfamily/akshare) requires Python(64 bit) 3.8 or greater, aims to make fetch financial data as convenient as possible. **Write less, get more!** - Documentation: [中文文档](https://akshare.akfamily.xyz/) ![](https://github.com/akfamily/akshare/blob/main/assets/images/akshare.svg) ## Installation ### General ```shell pip install akshare --upgrade ``` ### China ```shell pip install akshare -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host=mirrors.aliyun.com --upgrade ``` ### PR Please check out [documentation](https://akshare.akfamily.xyz/contributor.html) if you want to contribute to AKShare ### Docker #### Pull images ```shell docker pull registry.cn-shanghai.aliyuncs.com/akfamily/aktools:jupyter ``` #### Run Container ```shell docker run -it registry.cn-shanghai.aliyuncs.com/akfamily/aktools:jupyter python ``` #### Test ```python import akshare as ak print(ak.__version__) ``` ## Usage ### Data Code: ```python import akshare as ak stock_zh_a_hist_df = ak.stock_zh_a_hist(symbol="000001", period="daily", start_date="20170301", end_date='20231022', adjust="") print(stock_zh_a_hist_df) ``` Output: ``` 日期 开盘 收盘 最高 ... 振幅 涨跌幅 涨跌额 换手率 0 2017-03-01 9.49 9.49 9.55 ... 0.84 0.11 0.01 0.21 1 2017-03-02 9.51 9.43 9.54 ... 1.26 -0.63 -0.06 0.24 2 2017-03-03 9.41 9.40 9.43 ... 0.74 -0.32 -0.03 0.20 3 2017-03-06 9.40 9.45 9.46 ... 0.74 0.53 0.05 0.24 4 2017-03-07 9.44 9.45 9.46 ... 0.63 0.00 0.00 0.17 ... ... ... ... ... ... ... ... ... 1610 2023-10-16 11.00 11.01 11.03 ... 0.73 0.09 0.01 0.26 1611 2023-10-17 11.01 11.02 11.05 ... 0.82 0.09 0.01 0.25 1612 2023-10-18 10.99 10.95 11.02 ... 1.00 -0.64 -0.07 0.34 1613 2023-10-19 10.91 10.60 10.92 ... 3.01 -3.20 -0.35 0.61 1614 2023-10-20 10.55 10.60 10.67 ... 1.51 0.00 0.00 0.27 [1615 rows x 11 columns] ``` ### Plot Code: ```python import akshare as ak import mplfinance as mpf # Please install mplfinance as follows: pip install mplfinance stock_us_daily_df = ak.stock_us_daily(symbol="AAPL", adjust="qfq") stock_us_daily_df = stock_us_daily_df[["open", "high", "low", "close", "volume"]] stock_us_daily_df.columns = ["Open", "High", "Low", "Close", "Volume"] stock_us_daily_df.index.name = "Date" stock_us_daily_df = stock_us_daily_df["2020-04-01": "2020-04-29"] mpf.plot(stock_us_daily_df, type='candle', mav=(3, 6, 9), volume=True, show_nontrading=False) ``` Output: ![KLine](https://jfds-1252952517.cos.ap-chengdu.myqcloud.com/akshare/readme/home/AAPL_candle.png) ## Communication Pay attention to **数据科学实战** Official Accounts to get more information about Quant, ML, DS and so on, please visit [数据科学实战](https://akshare.akfamily.xyz/introduction.html) for more information:
data science
Pay attention to **数据科学实战** WeChat Official Accounts to get the [AKShare](https://github.com/akfamily/akshare) updated info:
ds
Application to add **AKShare-VIP QQ group** and talk about [AKShare](https://github.com/akfamily/akshare) issues, please contact **AKShare-小助手 QQ**: 1254836886 ![QRCode](https://jfds-1252952517.cos.ap-chengdu.myqcloud.com/akshare/readme/qrcode/qr_code_1254836886.jpg) ## Features - **Easy of use**: Just one line code to fetch the data; - **Extensible**: Easy to customize your own code with other application; - **Powerful**: Python ecosystem. ## Tutorials 1. [Overview](https://akshare.akfamily.xyz/introduction.html) 2. [Installation](https://akshare.akfamily.xyz/installation.html) 3. [Tutorial](https://akshare.akfamily.xyz/tutorial.html) 4. [Data Dict](https://akshare.akfamily.xyz/data/index.html) 5. [Subjects](https://akshare.akfamily.xyz/topic/index.html) ## Contribution [AKShare](https://github.com/akfamily/akshare) is still under developing, feel free to open issues and pull requests: - Report or fix bugs - Require or publish interface - Write or fix documentation - Add test cases > Notice: We use [Ruff](https://github.com/astral-sh/ruff) to format the code ## Statement 1. All data provided by [AKShare](https://github.com/akfamily/akshare) is just for academic research purpose; 2. The data provided by [AKShare](https://github.com/akfamily/akshare) is for reference only and does not constitute any investment proposal; 3. Any investor based on [AKShare](https://github.com/akfamily/akshare) research should pay more attention to data risk; 4. [AKShare](https://github.com/akfamily/akshare) will insist on providing open-source financial data; 5. Based on some uncontrollable factors, some data interfaces in [AKShare](https://github.com/akfamily/akshare) may be removed; 6. Please follow the relevant open-source protocol used by [AKShare](https://github.com/akfamily/akshare); 7. Provide HTTP API for the person who uses other program language: [AKTools](https://aktools.readthedocs.io/). ## Show your style Use the badge in your project's README.md: ```markdown [![Data: akshare](https://img.shields.io/badge/Data%20Science-AKShare-green)](https://github.com/akfamily/akshare) ``` Using the badge in README.rst: ``` .. image:: https://img.shields.io/badge/Data%20Science-AKShare-green :target: https://github.com/akfamily/akshare ``` Looks like this: [![Data: akshare](https://img.shields.io/badge/Data%20Science-AKShare-green)](https://github.com/akfamily/akshare) ## Citation Please use this **bibtex** if you want to cite this repository in your publications: ```markdown @misc{akshare, author = {Albert King}, title = {AKShare}, year = {2019}, publisher = {GitHub}, journal = {GitHub repository}, howpublished = {\url{https://github.com/akfamily/akshare}}, } ``` ## Acknowledgement Special thanks [FuShare](https://github.com/LowinLi/fushare) for the opportunity of learning from the project; Special thanks [TuShare](https://github.com/waditu/tushare) for the opportunity of learning from the project; Thanks for the data provided by [生意社网站](http://www.100ppi.com/); Thanks for the data provided by [奇货可查网站](https://qhkch.com/); Thanks for the data provided by [中国银行间市场交易商协会网站](http://www.nafmii.org.cn/); Thanks for the data provided by [99期货网站](http://www.99qh.com/); Thanks for the data provided by [英为财情网站](https://cn.investing.com/); Thanks for the data provided by [中国外汇交易中心暨全国银行间同业拆借中心网站](http://www.chinamoney.com.cn/chinese/); Thanks for the data provided by [金十数据网站](https://www.jin10.com/); Thanks for the data provided by [和讯财经网站](http://www.hexun.com/); Thanks for the data provided by [新浪财经网站](https://finance.sina.com.cn/); Thanks for the data provided by [Oxford-Man Institute 网站](https://realized.oxford-man.ox.ac.uk/); Thanks for the data provided by [DACHENG-XIU 网站](https://dachxiu.chicagobooth.edu/); Thanks for the data provided by [上海证券交易所网站](http://www.sse.com.cn/assortment/options/price/); Thanks for the data provided by [深证证券交易所网站](http://www.szse.cn/); Thanks for the data provided by [北京证券交易所网站](http://www.bse.cn/); Thanks for the data provided by [中国金融期货交易所网站](http://www.cffex.com.cn/); Thanks for the data provided by [上海期货交易所网站](http://www.shfe.com.cn/); Thanks for the data provided by [大连商品交易所网站](http://www.dce.com.cn/); Thanks for the data provided by [郑州商品交易所网站](http://www.czce.com.cn/); Thanks for the data provided by [上海国际能源交易中心网站](http://www.ine.com.cn/); Thanks for the data provided by [Timeanddate 网站](https://www.timeanddate.com/); Thanks for the data provided by [河北省空气质量预报信息发布系统网站](http://110.249.223.67/publish/); Thanks for the data provided by [南华期货网站](http://www.nanhua.net/nhzc/varietytrend.html); Thanks for the data provided by [Economic Policy Uncertainty 网站](http://www.nanhua.net/nhzc/varietytrend.html); Thanks for the data provided by [微博指数网站](https://data.weibo.com/index/newindex); Thanks for the data provided by [百度指数网站](http://index.baidu.com/v2/main/index.html); Thanks for the data provided by [谷歌指数网站](https://trends.google.com/trends/?geo=US); Thanks for the data provided by [申万指数网站](http://www.swsindex.com/idx0120.aspx?columnid=8832); Thanks for the data provided by [真气网网站](https://www.zq12369.com/); Thanks for the data provided by [财富网站](http://www.fortunechina.com/); Thanks for the data provided by [中国证券投资基金业协会网站](http://gs.amac.org.cn/); Thanks for the data provided by [Expatistan 网站](https://www.expatistan.com/cost-of-living); Thanks for the data provided by [北京市碳排放权电子交易平台网站](https://www.bjets.com.cn/article/jyxx/); Thanks for the data provided by [国家金融与发展实验室网站](http://www.nifd.cn/); Thanks for the data provided by [IT桔子网站](https://www.itjuzi.com); Thanks for the data provided by [东方财富网站](http://data.eastmoney.com/jgdy/); Thanks for the data provided by [义乌小商品指数网站](http://www.ywindex.com/Home/Product/index/); Thanks for the data provided by [中国国家发展和改革委员会网站](http://jgjc.ndrc.gov.cn/dmzs.aspx?clmId=741); Thanks for the data provided by [163网站](https://news.163.com/special/epidemic/); Thanks for the data provided by [丁香园网站](http://3g.dxy.cn/newh5/view/pneumonia?scene=2&clicktime=1579615030&enterid=1579615030&from=groupmessage&isappinstalled=0); Thanks for the data provided by [百度新型肺炎网站](https://voice.baidu.com/act/newpneumonia/newpneumonia/?from=osari_pc_1); Thanks for the data provided by [百度迁徙网站](https://qianxi.baidu.com/?from=shoubai#city=0); Thanks for the data provided by [新型肺炎-相同行程查询工具网站](https://rl.inews.qq.com/h5/trip?from=newsapp&ADTAG=tgi.wx.share.message); Thanks for the data provided by [新型肺炎-小区查询网站](https://ncov.html5.qq.com/community?channelid=1&from=singlemessage&isappinstalled=0); Thanks for the data provided by [商业特许经营信息管理网站](http://txjy.syggs.mofcom.gov.cn/); Thanks for the data provided by [慈善中国网站](http://cishan.chinanpo.gov.cn/platform/login.html); Thanks for the data provided by [思知网站](https://www.ownthink.com/); Thanks for the data provided by [Currencyscoop 网站](https://currencyscoop.com/); Thanks for the data provided by [新加坡交易所网站](https://www.sgx.com/zh-hans/research-education/derivatives); Thanks for the tutorials provided by [微信公众号: Python大咖谈](https://upload-images.jianshu.io/upload_images/3240514-61004f2c71be4a0b.png). ## Backer and Sponsor jetbrains