BigQuant使用文档

SDK 使用文档(内部测试,暂不对外)

由qxiao创建,最终由qxiao 被浏览 271 用户

一、下载安装SDK

1. 使用 bigquant 数据SDK,需要python3.8以上,首先使用 pip 安装包

pip3 install bigquantdai

2. 获取访问凭证

第一步:点击进入以下地址,若提示无账户则申请账户即可



第二步:点击”新增访问凭证“,填写您的“凭证名称”,并点击“创建凭证“,系统会返回给您一个secret_key,请妥善保存。界面上的【密钥ID】栏是对应的access_key。如果您遗失secret_key,请删除该凭证并重新申请。注意:access_key 和 secret_key 是 SDK 的关键信息,请一定妥善保管。

3. 申请SDK权限

暂不对外开放

4. 在本地开发环境中使用 SDK

将 第3步 中获取的 access_key 和 secret_key 在此处进行替换

from bigquantdai import dai
import pandas as pd

access_key = "xxxxxx"
secret_key = "xxxxxx"
dai.login(access_key, secret_key)
dai.DataSource("cn_stock_bar1d").read_bdb(
    as_type=pd.DataFrame,
    columns=['date', 'instrument', 'close'],
    partition_filter={
        'date': ('2024-03-01', '2024-04-20'),
        'instrument': {'000001.SZ', '000002.SZ'}
    }
)

二、SDK接口说明

1. 登陆

使用访问凭证(access_key 和 secret_key)在本地开发环境登陆SDK

dai.login (access_key: str, secret_key: str)

2. Quota 查询

获取配额和权限信息。

dai.quota()

返回值:

  • 类型:Dict。weekly_quota为周配额,used_quota为当周已使用配额,datasources为您有权限读取的数据源列表。

3. 读取数据

\

dai.DataSource.read_bdb
dai.DataSource.read_bdb (as_type=pa.Table, partition_filter=None, columns=None) -> pa.Table | pd.DataFrame

参数:

  • as_type: Union[pa.Table, pd.DataFrame],返回类型,默认为pa.Table。
  • partition_filter: Dict[str, Union[tuple, set]],分区过滤条件,默认为None。
  • columns: List[str],返回部分列,默认为None。

返回值:

  • pa.Table,当as_type为pa.Table时返回。
  • pd.DataFrame,当as_type为pd.DataFrame时返回。\n

三、SDK可免费访问的表

用户可以通过 dai.quota() 命令查看quota使用情况和有访问权限的表。

各张表详情见“数据平台”:https://bigquant.com/data/home

表名 中文名
all_trading_days 全年交易日历
cn_stock_instruments 中国股票列表
holidays 节假日
trading_days 交易日历
cn_future_instruments 期货列表
cn_fund_instruments 基金代码列表
cn_cbond_instruments 可转债代码列表
cn_stock_bar1d 复权日行情
cn_stock_real_bar1d 未复权日行情
cn_stock_limit_price 涨跌停价格
cn_stock_wap 加权平均价格
cn_stock_valuation 估值信息
cn_stock_st ST记录
cn_stock_suspend 停复牌信息
cn_stock_dividend 分红信息
cn_stock_basic_info 基本信息
cn_stock_capital 股本信息
cn_stock_status 股票状态
cn_stock_allotment 配股信息
cn_stock_financial_changedate 财报变更日期
cn_stock_financial_income_general_pit 利润表PIT(一般企业)
cn_stock_financial_balance_general_pit 资产负债表PIT(一般企业)
cn_stock_financial_cashflow_general_pit 现金流量表PIT(一般企业)
cn_stock_index_bar1d 股票指数日行情
cn_stock_index_info 指数基本信息
cn_stock_index_component 股票指数成分
cn_stock_index_change 指数进出记录
cn_stock_industry 行业分类标准
cn_stock_industry_component 行业成分
cn_stock_industry_change 行业进出记录
cn_stock_industry_sw_bar1d 申万行业日行情
cn_stock_industry_bar1d 后复权日行情
cn_stock_industry_real_bar1d 未复权日行情
cn_future_bar1d 期货日行情
cn_future_level1_snapshot 期货快照行情
cn_future_adjust_factor 期货复权因子
cn_future_bar1d_adjust 期货复权日行情
cn_future_basic_info 基本信息
cn_fund_bar1d 基金复权行情数据
cn_fund_bar1m 基金分钟数据
cn_fund_basic_info 基金基本信息
cn_cbond_bar1d 可转债日行情
cn_cbond_revise 可转债修正条款
cn_cbond_interest 可转债利息条款
cn_cbond_resale 可转债回售条款
cn_cbond_basic_info 可转债基本资料
cn_cbond_rating 可转债基本评级
cn_cbond_redemption 可转债赎回条款
cn_cbond_conversion 可转债转股条款
cn_stock_factors_base 基础因子
cn_stock_factors_ta 技术因子
cn_stock_factors_financial_items 财务科目
cn_stock_factors_hf 高频因子

\

评论
  • undefined
  • 预计2024年5月中旬上线
  • 这个需要哪个python版本?
  • 上线了吗
  • 上线了吗请问,我这边还是没有权限
{link}