Datayes API Skill

金融数据 API，为 AI 而生

上百个标准接口，覆盖投研线索、行情数据、财务分析、基金、公告、会议纪要和 AI 搜索，让 AI Agent 能用对数据、查到原文、生成可追溯答案。

查看 API 文档查看定价方案

通过 Skill 使用 API

1. 安装 Datayes API 调用 Skill在Claw、Codex或Claude对话框中发送Skill安装链接：/skills/datayes-api-skill.zip

2. 输入 Token 密钥按提示填入 Datayes Token 密钥，完成当前账号的 API 鉴权配置。

3. 直接对话调用 API之后可通过对话方式直接调用 API，实现精准的金融内容问答。

一、鉴权方式

所有 API 请求都需要在 HTTP Header 中携带 Token 进行身份验证。

Header 名Authorization

Header 值Bearer <your_token>

获取方式登录 Datayes API 控制台，点击「查看当前用户 Token」

提示：访客模式下可先浏览 API 目录和文档，无需 Token。只有实际发起调用时才需要登录获取 Token。

二、调用流程总览

无论是大模型 Agent 还是人类开发者，推荐按照以下标准闭环执行：

1. 找到 API
api_mix_search 或 api_catalog→2. 读取定义
api_info→3. 构造请求
按参数拼装 curl→4. 发起调用
携带 Bearer Token

找到候选 API — 用 api_mix_search 按自然语言搜索最匹配的 API，或用 api_catalog 浏览完整目录树（亦可前往 API 目录）。

读取 API 完整定义— 拿到候选 API 的英文名（nameEn）后，调用 api_info 获取该接口的完整入参、出参、HTTP 方法和 URL。

构造并执行请求 — 根据 api_info 返回的定义，填写必填参数，拼装 curl 或 SDK 请求，携带 Authorization: Bearer <token> 发起调用。

重要：标准闭环是 api_mix_search（或 api_catalog）→ api_info→ 业务 API。请勿跳过 api_info 步骤直接调用业务接口，否则可能因参数不完整而失败。

三、核心导航 API

这三个接口不是业务数据接口，而是帮助 AI 和开发者导航整个 API 体系的元能力：

GETAPI 搜索api_mix_search

按自然语言问题或关键词搜索最匹配的 API，是问题驱动场景下最快的入口。返回候选 API 列表及匹配分数。

URLhttps://gw.datayes.com/aladdin_llm_mgmt/web/whitelist/api/search/mix

参数通过 query 传入搜索关键词或自然语言问题

适用场景当用户有明确需求但不确定使用哪个 API 时，用自然语言描述需求即可快速匹配。例如："查询研报相关API" → 研报类接口；"获取股票财务数据" → 财务类接口；"ETF资金流向" → ETF资金相关接口

curl 示例

curl -X GET "https://gw.datayes.com/aladdin_llm_mgmt/web/whitelist/api/search/mix?query=查询研报相关API" \
  -H "Authorization: Bearer <token>"

GETAPI 目录api_catalog

获取平台全部 API 的分类目录树，返回所有分类及其下属 API 列表。适合需要一次性浏览全部可用接口的场景。

URLhttps://gw.datayes.com/aladdin_llm_mgmt/web/whitelist/api/catalog/all

参数可选：传入目录名称或目录 ID 获取指定分类下的 API 列表；不传参数则返回全部分类目录树

返回内容分类树结构，每个分类下包含 API 名称（name）、英文标识（nameEn）、摘要（summary）

适用场景需要浏览全部可用 API 或查看某个分类下有哪些接口时使用

curl 示例

curl -X GET "https://gw.datayes.com/aladdin_llm_mgmt/web/whitelist/api/catalog/all" \
  -H "Authorization: Bearer <token>"

GETAPI 信息api_info

查询单个 API 的完整定义，包括：HTTP 方法、URL、所有入参（名称/类型/是否必填/默认值）和出参。是正式调用前的必经步骤。

URLhttps://gw.datayes.com/aladdin_llm_mgmt/web/whitelist/api?nameEn={API英文名}

必填参数nameEn — API 的英文标识（从 api_mix_search 或下方概览表中获取）

返回内容httpMethod, httpUrl, parametersInput（含 name/nameEn/type/mandatory/defaultValue）

适用场景在确定目标 API 的 nameEn 后、正式发起业务调用之前，必须先调用此接口获取完整参数定义

curl 示例（以 getMaterialsV2 为例）

curl -X GET "https://gw.datayes.com/aladdin_llm_mgmt/web/whitelist/api?nameEn=getMaterialsV2" \
  -H "Authorization: Bearer <token>"

四、可直接复制给大模型的调用模板

输入 API 英文名，一键生成包含鉴权方式和调试 curl 的完整模板，可直接复制给 AI Agent 执行。

当前 API 模板：getMaterialsV2

## Datayes API 调用协议

当前 API：
- 名称：AI搜索-召回结构化数据
- 英文名：getMaterialsV2

### 鉴权
所有请求 Header 必须携带：Authorization: Bearer <token>

### 第一步：获取 API 完整定义
curl -X GET "https://gw.datayes.com/aladdin_llm_mgmt/web/whitelist/api?nameEn=getMaterialsV2" \
  -H "Authorization: Bearer <token>"

### 第二步：根据返回的定义构造请求
- 使用返回的 httpMethod（POST）和 httpUrl 作为请求方法和地址
- 遍历 parametersInput，填写所有 mandatory=true 的参数
- 参数位置参照 location 字段：Body 放请求体，Query 放 URL 参数

### 第三步：发起业务请求
curl -X POST "https://gw.datayes.com/aladdin_info/web/getMaterialsV2" \
  -H "Authorization: Bearer <token>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"question":"<question>","queryScope":"research,researchTable,meetingSummary"}'

# 参数说明：
# question (必填, string) - 用户问题
# queryScope (必填, string) - 查询范围

### 执行要求
1. 必须先调用 api_info 获取完整参数定义，不要凭记忆猜测参数。
2. 如果 api_info 显示存在必填参数（mandatory=true），则必须填写。
3. 返回结果时保留关键英文字段名，并补充中文说明。
4. 如果结果不完整或报错，先检查是否缺少必填参数，再决定是否重试。

五、常见问题

Q: 我不知道该用哪个 API，怎么办？

直接用自然语言调用 api_mix_search，例如传入 "查询研报相关API"，系统会返回最匹配的 API 列表。

Q: 有哪些常见错误码？

以下是一些通用的错误码和错误信息，以及处理建议：

code	message	说明	常见处理方式
-1	no data	查询无结果	调整查询条件
-21	parameter validation error	参数校验失败	检查并修正请求参数
-1403	need privilege	无操作权限	申请或检查账号权限
500	内部服务器错误，请稍后重试	服务端内部错误	重试或联系运维
-403	Need login	未登录或 token 无效	检查 token 有效性或提供有效 token

若以上无法解决，请提供完整请求入参、时间戳及环境信息，联系客服。

Q: 如何知道某个 API 的所有参数？

调用 api_info?nameEn=xxx，返回的 parametersInput 数组包含每个参数的名称、类型、是否必填和默认值。也可以在上方第四节直接输入英文名生成模板。

Q: GET 和 POST 请求的参数位置有什么区别？

参考 api_info 返回中每个参数的 location 字段。Query 表示放在 URL 查询参数中，Body 表示放在 JSON 请求体中，Path 表示嵌入 URL 路径。

Q: 有没有 SDK 或 Python 示例？

目前以 RESTful API + curl 为主。Python 调用示例如下：

Python 示例

import requests

TOKEN = "your_token_here"
HEADERS = {
    "Authorization": f"Bearer {TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json"
}

# 1. 搜索相关 API
resp = requests.get(
    "https://gw.datayes.com/aladdin_llm_mgmt/web/whitelist/api/search/mix",
    params={"query": "搜索投研资料"},
    headers=HEADERS
)
print(resp.json())

# 2. 获取 API 定义
resp = requests.get(
    "https://gw.datayes.com/aladdin_llm_mgmt/web/whitelist/api",
    params={"nameEn": "getMaterialsV2"},
    headers=HEADERS
)
api_def = resp.json()["data"]
print(f"URL: {api_def['httpUrl']}, Method: {api_def['httpMethod']}")

# 3. 调用业务 API
resp = requests.post(
    api_def["httpUrl"],
    json={"question": "分析一下光伏行业产业链", "queryScope": "research,researchTable,meetingSummary"},
    headers=HEADERS
)
print(resp.json())

Q: 如何开通账户？

当前注册入口将对接统一账号页面。可先查看定价方案并上传名片，或通过导航栏右上角的联系销售入口开通。

Q: 定价方案怎么选？

平台采用积分制按量计费，导航类 API（搜索/目录/信息）永久免费。详细方案请查看定价页面。