接口文档 – 大白鹅

1、安装库

安装cashare库

pip install cashare

更新库（注意为两个–）

pip install --upgrade cashare

注意：you_token请联系管理员获取（联系我们管理员获取，联系方式:qq:3254597724），权限分为日线权限、分钟权限、实时权限。

2、获取列表：

输入type取值：

us	hk			etf	eu	~~tsx~~	fx
us美国9900多支	香港			目前只包含美股常用的一部分，可以联系管理员添加	欧洲交易所	~~多伦多交易所2800支~~	~~外汇1500种~~

输出参数：

ca_code	name	exchangeShortName	type	industry_id	industry_name
代码	公司名称	交易所名称	类型	三级行业编码，（可以根据行业接口，确定该股票属于的一级和二级的行业）	三级行业名称

import cashare as ca
ca.set_token('找管理员获取的token')#token 设置一次即可，不用每次都设置该代码
df = ca.stock_list(type='hk' )
df = ca.stock_list(type='us' )
print(df)

     ca_code  ... industry_name
0          A  ...       实验室分析仪器
1         AA  ...           铝生产
2        AAC  ...   金属板加工（锅炉车间）
3       AACB  ...          None
4      AACBR  ...          None
...      ...  ...           ...
9898      ZY  ...     商业物理及生物研究
9899    ZYBT  ...          药品制剂
9900    ZYME  ...          药品制剂
9901    ZYNE  ...          药品制剂
9902    ZYXI  ...     电子医疗及电疗设备

2、日线（美股（30年）、~~港股（20年~~）~~欧洲、多伦多~~）注意ca_code的值需要和获取列表的返回值一致。例如：中芯国际代码0981.HK（可能会和部分券商的代码不太一致）

输入参数：

ca_code	start_date	end_date	adj
股票代码	开始日期	结束日期	默认不填写为不复权 qfq为前复权 hfq为后复权

输出参数：

ca_code	open	high	low	close	volume
代码	开盘价格	日内最高	日内最低	收盘价格	成交量（股）

代码示例：

import cashare as ca
ca.set_token('找管理员获取的token')
df = ca.daily_data(ca_code="aapl", start_date='2025-01-08',end_date='2025-09-22')
print(df)

  ca_code       date    open    high     low   close     volume
0     AAPL 2025-01-08  241.92  243.71  240.05  242.70   37628940
1     AAPL 2025-01-10  240.01  240.16  233.00  236.85   61710900
2     AAPL 2025-01-13  233.53  234.67  229.72  234.40   49630725
3     AAPL 2025-01-14  234.75  236.12  232.47  233.28   39435300
4     AAPL 2025-01-15  234.64  238.96  234.43  237.87   39832000
5     AAPL 2025-01-16  237.35  238.01  228.03  228.26   71759100

3、历史美股分钟（2003年12月1日开始，未复权）；（目前只包含接口14（index_member）：指数包含中标普500指数 SPX、道琼斯工业平均指数DJIA、纳斯达克100 NDX内的代码，如果有需要其他的可以联系管理员添加），默认返回6000行，需要循环获取，或者使用us_all_min_data获取全部分钟数据。

输入参数：

ca_code	freq	start_date	end_date	offset
股票代码	分钟类型（取值：1min/5min/15min/30min/1hour/4hour）	开始时间	结束时间	从开始时间到结束之间的数据第几行开始（注意该参数用于us_min_data，不用于us_all_min_data）

import cashare as ca
ca.set_token('you_token')    
df=ca.us_min_data(ca_code="aapl", freq='1min',start_date='2023-06-05',end_date='2023-07-22',)
print(df)

 ca_code                date     open  ...       low     close   volume
0       AAPL 2023-06-05 09:30:00  182.630  ...  181.9700  182.3400  2188333
1       AAPL 2023-06-05 09:31:00  182.342  ...  182.2600  182.6800   940478
2       AAPL 2023-06-05 09:32:00  182.710  ...  182.5800  182.9100   602680
3       AAPL 2023-06-05 09:33:00  182.915  ...  182.8600  183.4499   869437
4       AAPL 2023-06-05 09:34:00  183.420  ...  183.0601  183.3050   539744
...      ...                 ...      ...  ...       ...       ...      ...
5995    AAPL 2023-06-27 11:55:00  187.205  ...  187.1371  187.2100    88150
5996    AAPL 2023-06-27 11:56:00  187.210  ...  187.1400  187.1599    83287
5997    AAPL 2023-06-27 11:57:00  187.150  ...  187.0800  187.0950    76243
5998    AAPL 2023-06-27 11:58:00  187.100  ...  187.0900  187.1100    50562
5999    AAPL 2023-06-27 11:59:00  187.100  ...  187.1000  187.1150    39092

df = ca.us_all_min_data(ca_code="aapl", freq='1min',start_date='2023-06-05',end_date='2023-07-22',)#循环获取该时间段内分钟数据，但是时间会比较长。
print(df)

   ca_code                date     open  ...       low     close   volume
0        AAPL 2023-06-05 09:30:00  182.630  ...  181.9700  182.3400  2188333
1        AAPL 2023-06-05 09:31:00  182.342  ...  182.2600  182.6800   940478
2        AAPL 2023-06-05 09:32:00  182.710  ...  182.5800  182.9100   602680
3        AAPL 2023-06-05 09:33:00  182.915  ...  182.8600  183.4499   869437
4        AAPL 2023-06-05 09:34:00  183.420  ...  183.0601  183.3050   539744
...       ...                 ...      ...  ...       ...       ...      ...
12685    AAPL 2023-07-21 15:55:00  191.950  ...  191.9400  192.0400   498699
12686    AAPL 2023-07-21 15:56:00  192.050  ...  191.9500  191.9667   367333
12687    AAPL 2023-07-21 15:57:00  191.960  ...  191.8000  191.8700   329266
12688    AAPL 2023-07-21 15:58:00  191.880  ...  191.8300  191.8300   393255
12689    AAPL 2023-07-21 15:59:00  191.830  ...  191.7800  191.9300  1066652

4、实时美股分钟

输入参数：

ca_code	type
股票代码	取值：1min/5min/15min/30min/1hour/4hour

输出参数：

ca_code	date	open	close	high	low	volume
代码	时间日期	开盘	收盘	高	低	成交量（手）

import cashare as ca
 ca.set_token('你的token')
 df=ca.min_data(ca_code="AAPL",type='1hour')
 print(df)

ca_code                 date    open     low    high   close     volume
0    AAPL  2025-05-09 15:30:00  198.82  198.27  198.93  198.46  7516887.0
1    AAPL  2025-05-09 14:30:00  198.95  198.71  199.43  198.80  2945367.0
2    AAPL  2025-05-09 13:30:00  198.15  197.91  199.10  198.93  2470206.0
3    AAPL  2025-05-09 12:30:00  198.11  197.60  198.44  198.15  3054224.0
4    AAPL  2025-05-09 11:30:00  198.42  197.93  199.00  198.13  2891812.0
5    AAPL  2025-05-09 10:30:00  198.35  197.54  199.18  198.42  4551929.0
6    AAPL  2025-05-09 09:30:00  199.00  198.11  200.53  198.37  9737491.0

5、美股实时日线接口（只获取当前时间点的价格）：type取值具体的股票代码，例如aapl

输入参数：

type=’us’	其他（具体股票代码，例如aapl）type=’aapl’
全部美股	也可获取以上的某个code实时价格

输出参数：

ca_code

time

open

now_price

daylow

dayhigh

pre_close

chg_pt

volume

yearlow

yearhigh

sharesout

m_c

股票代码

时间

开盘价格

当前价格

日内最低

日内最高

昨日收盘

涨跌幅

成交量

52周最低

52周最高

总股本

市值

示例：

import cashare as ca
 ca.set_token('你的token')
 df = ca.now_data(type='aapl')  
 print(df)

  ca_code                time     open  ...  yearhigh    sharesout            m_c
0    AAPL 2025-05-07 20:00:02  199.195  ...    260.10  15022100000  2948087125000
1      AA 2025-05-07 20:00:02   24.750  ...     47.77    258884000     6316769600

6、美股个股市值

输入参数：

ca_code	start_date	end_date
代码	开始日期	结束日期

输出参数：

ca_code	date	marketCap
代码	日期	（市值）

示例：

 import cashare as ca
 ca.set_token('you_token')
df=ca.mark_c_data(ca_code='A',start_date='1990-09-05',end_date='2025-09-09')
print(df)

  ca_code       date      marketCap
0       AAPL 2000-09-05    20323957920
1       AAPL 2000-09-06    19042266880
2       AAPL 2000-09-07    20323957920
3       AAPL 2000-09-08    19225365600
4       AAPL 2000-09-11    19042266880

7、所有股票拆分（美股）

输入参数：

ca_code

股票代码（包含美股、港股），请使用列表接口返回的股票代码，

输出参数：

date	ca_code	after	before
日期	代码	合并后	合并前

 import cashare as ca
 ca.set_token('你的token')
 df=ca.sp_data( ca_code='aapl')
 print(df)

     date ca_code  after  before
0  2000-06-21    AAPL    2.0     1.0
1  2005-02-28    AAPL    2.0     1.0
2  2014-06-09    AAPL    7.0     1.0
3  2020-08-31    AAPL    4.0     1.0

8、个股股息（美股）

输入参数：

ca_code

股票代码（包含美股、港股），请使用列表接口返回的股票代码，

输出参数：

date	ca_code	dividend	recorddate	paydate	decdate
除权除息日	股票	股息	截止过户日	现金发放日	公告日期

 import cashare as ca
ca.set_token('你的token')
df=ca.div_data(ca_code='aapl')
print(df)
   date ca_code  dividend  recorddate     paydate     decdate
0  1990-02-16    AAPL      0.11  1990-02-23  1990-03-15  1990-02-02
1  1990-05-21    AAPL      0.11  1990-05-25  1990-06-15  1990-04-09
2  1990-08-20    AAPL      0.11  1990-08-24  1990-09-14  1990-07-23
3  1990-11-16    AAPL      0.12  1990-11-23  1990-12-14  1990-11-08

9、美股财务数据-利润表

输入参数：

ca_code	period（取值）
股票代码	年报：annual 季报：quarter

输出参数

ann_date	财报发布日期
report_date	报表日期
ca_code	股票代码
period	报告期间(财年：FY，一季度：Q1）
revenue	营业收入（美元）
cor	营业成本
grossProfit	毛利
grossProfit_r	毛利率
rd_exp	研发支出
ga_exp	一般及行政支出
sm_exp	销售及市场推广支出
sga_exp	销售、一般及行政支出
otherExpenses	其他支出
operatingExpenses	营业费用
costAndExpenses	成本与支出
interestIncome	利息收入
interestExpense	利息支出
dep_amort	折旧与摊销
ebitda	息税折旧摊销前利润
ebitdaratio	息税折旧摊销前利润比率
o_income	营业利润
o_income_r	营业利润率
noi	其他收入（损失）净额
pti	税前利润
pri_r	税前利润率
incomeTax_exp	所得税支出
netIncome	净利润
netIncomeRatio	净利润率
eps	每股收益
epsdiluted	稀释每股收益
wasb	加权平均股数
wasd	加权平均股数（稀释）

 import cashare as ca
 ca.set_token('r9fcbc791fa47741af9d440bdeb98d9a532')
 df = ca.income_data(ca_code='AAPL',period='annual',)
 print(df)
  date ca_code period  ...  epsdiluted         wasb         wasd
0  1985-09-30    AAPL     FY  ...      0.0045  13708800000  13708800000
1  1986-09-30    AAPL     FY  ...      0.0107  14373333333  14373333333
2  1987-09-30    AAPL     FY  ...      0.0148  14674698795  14674698795
3  1988-09-30    AAPL     FY  ...      0.0275  14556363636  14556363636
4  1989-09-30    AAPL     FY  ...      0.0316  14363841808  14363841808

10、美股财务数据-资产负债表

输入参数：

ca_code	period（取值）
股票代码	年报：annual 季报：quarter

ann_date	财报发布日期
report_date	报表日期
ca_code	股票代码
period	期间(财年：FY，一季度：Q1）
cash_eq	现金及现金等价物
sti	短期投资
cash_sti	现金及短期投资
netrecv	应收净额
inventory	存货
oca	其他流动资产
tca	流动资产总计
ppenet	固定资产净值
goodwill	商誉
ia	无形资产
gw_ia	商誉及无形资产
long_ti	长期投资
taxassets	税务资产
other_nca	其他非流动资产
total_nca	非流动资产总计
otherassets	其他资产
totalassets	资产总额
account_pay	应付账款
short_td	短期债务
tax_pay	应交税金
def_rev	递延收入
other_cl	其他流动负债
total_cl	流动负债总额
long_t_debt	长期债务
def_rev_nc	非流动递延收入
def_tax_liab_nc	非流动递延税负债
other_ncli	其他非流动负债
total_ncli	非流动负债总额
other_li	其他负债
cap_lo	资本租赁义务
total_li	负债总额
pref_stock	优先股
com_stock	普通股
ret_earn	留存收益
acc_oci	累积其他综合收益（损失）
other_se	其他股东权益
tse	股东权益总额
totalequity	权益总额
total_se	负债及股东权益总额
min_int	少数股东权益
tl_te	负债及权益总额
ti	投资总额
total_debt	债务总额
net_debt	净债务

import cashare as ca
ca.set_token('你的token')
df=ca.balance_data(ca_code='AAPL',period='annual')
print(df)

     date ca_code period  ...            ti    total_debt      net_debt
0 2019-09-28    AAPL     FY  ...  157054000000  108047000000   59203000000
1 2020-09-26    AAPL     FY  ...  153814000000  122278000000   84262000000
2 2021-09-25    AAPL     FY  ...  155576000000  136522000000  101582000000
3 2022-09-24    AAPL     FY  ...  145463000000  132480000000  108834000000
4 2023-09-30    AAPL     FY  ...  132134000000  111088000000   81123000000
5 2024-09-28    AAPL     FY  ...  126707000000  106629000000   76686000000

11、美股、财务数据-现金流量表

输入参数：

ca_code	period（取值）
股票代码	年报：annual 季报：quarter

输出参数：

ann_date	财报发布日期
report_date	报表日期
ca_code	股票代码
period	期间 (财年：FY，一季度：Q1）
netIncome	净利润
dep_amor	折旧与摊销
def_tax	递延所得税
sbc	股权激励
wc_change	营运资本变动
account_re	应收账款
inventory	存货
account_pay	应付账款
other_wc	其他营运资本
onc_items	其他非现金项目
op_cash_flow	经营活动产生的净现金流
ppe_inv	对固定资产的投资
acq_net	净收购
inv_purchases	投资购买
inv_sales_mat	投资出售/到期
oi_act	其他投资活动
inv_cash_used	投资活动使用的净现金流
debt_rep	债务偿还
cs_issued	发行普通股
cs_rep	回购普通股
dividendsPaid	支付股利
of_act	其他融资活动
fin_cash_flow	融资活动产生的净现金流
fx_effect	外汇变动对现金的影响
netChangeInCash	现金净变动
cash_eop	期末现金
cash_bop	期初现金
operatingCashFlow	经营现金流
cap_ex	资本支出
freeCashFlow	自由现金流

 import cashare as ca
 ca.set_token('你的token')
 df = ca.cash_flow_data(ca_code='AAPL',period='quarter',)    
print(df)

 date ca_code period  ...  operatingCashFlow      cap_ex  freeCashFlow
0   1989-12-31    AAPL     Q1  ...          261100000   -62900000     198200000
1   1990-03-31    AAPL     Q2  ...          303300000   -42800000     260500000
2   1990-06-30    AAPL     Q3  ...          301800000   -50800000     251000000
3   1990-09-30    AAPL     Q4  ...           97700000   -67800000      29900000
4   1990-12-31    AAPL     Q1  ...          226900000   -74200000     152700000

~~12 经济数据~~(暂无)

输入参数type 取值：

~~treasury~~	~~GDP~~	~~CPI~~
国债	国内生产总值	消费者物价指数

from cashare.econ import eco
df = eco(start_date='2021-01-01', end_date='2023-03-09', type='treasury', token='you_token')
print(df)

        date  month1  month2  month3  ...  year7  year10  year20  year30
0    2021-01-04    0.09    0.09    0.09  ...   0.64    0.93    1.46    1.66
1    2021-01-05    0.08    0.09    0.09  ...   0.66    0.96    1.49    1.70
2    2021-01-06    0.09    0.09    0.09  ...   0.74    1.04    1.60    1.81
3    2021-01-07    0.09    0.09    0.09  ...   0.78    1.08    1.64    1.85
4    2021-01-08    0.08    0.08    0.08  ...   0.81    1.13    1.67    1.87

13、指数日线

输入参数：

ca_code	start_date	end_date
指数代码取值：SPX、DJIA、IXIC、HSI、N225、RUT、VIX 标普500指数 SPX 道琼斯工业平均指数DJIA 纳斯达克综合指数 IXIC 恒生指数 HSI 日经225指数 N225 罗素2000指数 RUT 恐慌指数 VIX	开始日期	结束日期

输出参数：

ca_code	date	open	high	low	close	volume
指数代码	日期	开盘	最高	最低	收盘	交易量（部分指数可能没有交易量）

import cashare as ca
ca.set_token(you_token)
df = ca.index_daily(ca_code="spx", start_date='2023-06-05',end_date='2025-09-22')
print(df)

 ca_code       date     open     high      low    close      volume
0       SPX 2023-06-05  4282.99  4299.28  4266.82  4273.79  3813290000
1       SPX 2023-06-06  4271.34  4288.33  4263.09  4283.85  3996560000
2       SPX 2023-06-07  4285.47  4299.19  4263.96  4267.52  4537800000
3       SPX 2023-06-08  4268.69  4298.01  4261.07  4293.93  3826740000
4       SPX 2023-06-09  4304.88  4322.62  4291.70  4298.86  3786510000
..      ...        ...      ...      ...      ...      ...         ...
481     SPX 2025-05-06  5605.87  5649.58  5586.04  5606.90  4717260000
482     SPX 2025-05-07  5614.18  5654.73  5578.64  5631.27  4987440000
483     SPX 2025-05-08  5663.60  5720.10  5635.38  5663.95  5627400000
484     SPX 2025-05-09  5679.65  5691.69  5644.15  5659.90  4645090000
485     SPX 2025-05-12  5807.20  5845.37  5786.08  5844.20  6014580000

14、指数包含

输入参数：

ca_code

指数代码，取值：SPX、DJIA、NDX 标普500指数 SPX、道琼斯工业平均指数DJIA、纳斯达克100 NDX

输出参数：

index_code	ca_code	add_date
指数代码	股票名称	添加日期

 import cashare as ca
ca.set_token(you_token)
df = ca.index_member(ca_code="ndx",)
print(df)

    index_code ca_code   add_date
0          NDX    AAPL 1985-01-31
1          NDX    ABNB 2021-12-20
2          NDX    ADBE 1998-12-21
3          NDX     ADI 2012-09-23
4          NDX     ADP 2008-12-22
..         ...     ...        ...
96         NDX    VRTX 2006-12-18
97         NDX     WBD 2022-12-19
98         NDX    WDAY 2017-12-18
99         NDX     XEL 2018-11-19
100        NDX      ZS 2021-12-20

15、行业分类

输入参数：无，直接调用函数即可，采用sic行业分类

输出参数：

sector_id	sector_name	subsector_id	subsector_name	industry_id	industry_name
一级行业代码	一级行业名称	二级行业代码	二级行业名称	三级行业代码	三级行业名称

import cashare as ca
ca.set_token(you_token)
df = ca.industry()
print(df)


  sector_id sector_name  ... industry_id industry_name
0           A    农业、林业与渔业  ...       A0100         农作物生产
1           A    农业、林业与渔业  ...       A0200     畜牧及动物产品生产
2           A    农业、林业与渔业  ...       A0700          农业服务
3           A    农业、林业与渔业  ...       A0800            林业
4           A    农业、林业与渔业  ...       A0900      渔业、狩猎和诱捕
..        ...         ...  ...         ...           ...
418         I         服务业  ...       I8744      设施支持管理服务
419         I         服务业  ...       I8880        美国存托凭证
420         I         服务业  ...       I8900          其他服务
421         J        公共行政  ...       J9721          国际事务
422         J        公共行政  ...       J9995         非运营机构

16、~~大A实时接口（暂无）：~~

from cashare.stock.c_now import get_c_now
df=get_c_now(sk_code='all',token=you_token)
print('大A全部实时数据',df)

大A全部实时数据       Symbol StockName     Latest  ...  TurnoverRate  PERatioDynamic  PBRatio
0     000001      平安银行  11.200000  ...          0.27        4.280000     0.57
1     000002     万  科Ａ  13.080000  ...          0.31        7.910000     0.64
2     000003     PT金田A   0.000000  ...          0.00        0.000000     0.00