SDK 使用文档【未上线】

由qxiao创建，最终由qxiao更新于2024-05-07 02:25 被浏览 109 用户

一、下载安装SDK

1. 要开始使用 bigquant 数据SDK，首先使用 pip 安装包

pip3 install daisdk

2. 获取访问凭证

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

• https://bigquant.com/aiuser/access_key

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

3. 申请SDK权限

该功能预计2024年5月中旬上线，期间如有使用需求，请单独联系小Q。

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

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

from daisdk 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

\