BigQuant使用文档

Auth 用户管理 API

由small_q创建,最终由small_q 被浏览 5 用户

1 模块介绍

本模块提供 BigQuant 平台的用户认证和管理功能,支持多用户登录和信息查询。

2 API 介绍

2.1默认用户首次登陆

命令: bq --save-auth --aksk ak.sk\n功能:默认用户首次使用 AK/SK 登陆\n参数:

  • ak.sk: str, bigquant 平台注册的API Keys

    API Keys 获取步骤:

    • 登录 BigQuant 平台:https://bigquant.com
    • 点击 ”用户名“ 进入”个人中心“ → ”API Keys“
    • 点击 ”新增访问凭证“,保存新 AKSK

返回:“✓ Config saved to XXX”

2.2 多用户登陆

方法名:bigquant.from_config()\n功能:除默认用户,登陆其他用户\n参数:

  • path:str, 其他用户配置文件的绝对路径

    配置文件(json 格式)示例:

    {
      "auth": {
        "ak": "XXX",
        "sk": "XXX"
      }
    }
    

返回:Bigquant 对象

注意:其他用户调用模块功能时,需完整按照 用户.模块名.函数 的方式

2.3 获取用户信息

方法名:Bigquant.whoami()\n功能:获取用户信息

参数:无

返回:dict(包含用户名、用户ID等)

{link}