大白鹅
接口文档

接口文档

1、安装库

安装cashare库

pip install cashare

更新库 (注意为两个–)

pip install --upgrade cashare

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

2、获取列表:

输入type取值:

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

输出参数:

ca_codenameexchangeShortNametypeindustry_idindustry_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_codestart_dateend_dateadj
股票代码开始日期结束日期默认不填写为不复权
qfq为前复权
hfq为后复权

输出参数:

ca_codeopenhighlowclosevolume
代码开盘价格日内最高日内最低收盘价格成交量(股)

代码示例:

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、实时美股分钟。(历史分钟数据数据量大,后续支持)

输入参数:

ca_codetype
股票代码取值:1min/5min/15min/30min/1hour/4hour

输出参数:

ca_codedateopenclosehighlowvolume
代码时间日期开盘收盘成交量(手)
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

4、美股实时日线接口(只获取当前时间点的价格):type取值 具体的股票代码,例如aapl

输入参数:

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

输出参数:

ca_codetimeopennow_pricedaylowdayhighpre_closechg_ptvolumeyearlowyearhighsharesoutm_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

5、美股、港股个股市值

输入参数:

ca_codestart_dateend_date
代码开始日期结束日期

输出参数:

ca_codedatemarketCap
代码日期(市值)

示例:

 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

6、所有股票拆分(港美)

输入参数:

ca_code
股票代码(包含美股、港股),请使用列表接口返回的股票代码,

输出参数:

dateca_codeafterbefore
日期代码合并后合并前
 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

7、个股股息(港美)

输入参数:

ca_code
股票代码(包含美股、港股),请使用列表接口返回的股票代码,

输出参数:

dateca_codedividendrecorddatepaydatedecdate
除权除息日股票股息截止过户日现金发放日公告日期

 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

8、美股、港股财务数据-利润表

输入参数:

ca_codeperiod(取值)
股票代码年报:annual
季报:quarter
输出参数
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

9、美股,港股财务数据-资产负债表

输入参数:

ca_codeperiod(取值)
股票代码年报:annual
季报:quarter
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

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

输入参数:

ca_codeperiod(取值)
股票代码年报:annual
季报:quarter

输出参数:

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

11 经济数据(暂无)

输入参数type 取值:

treasuryGDPCPI
国债国内生产总值消费者物价指数
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


12、指数日线

输入参数:

ca_codestart_dateend_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

13、指数包含

输入参数:

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

14、行业分类

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

输出参数:

sector_idsector_namesubsector_idsubsector_nameindustry_idindustry_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         非运营机构

15、大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     万  科A  13.080000  ...          0.31        7.910000     0.64
2     000003     PT金田A   0.000000  ...          0.00        0.000000     0.00