唐诗宋词 - 咕咕数据 API 文档

唐诗宋词大全
接口详情官网地址: https://www.gugudata.com/api/details/chinesepoem

支持 40 万数据全文检索

请求方法: GET
接口路径: /text/chinesepoem
调试地址: https://api.gugudata.com/text/chinesepoem/demo
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

请求参数:

appkey (string, 必填): 付费后获取的 APPKEY

keywords (string, 必填): 查询关键字，会模糊匹配标题、作者与内容，结果按照类别、作者进行排序。内容关键字传递中文简体、中文繁体都可兼容搜索

pageSize (integer, 可选): 分页参数，每页总条数，取值范围在 1 ~ 20 之间

pageNumber (integer, 可选): 分页参数，第几页

type (string, 可选): 数据分类，可选参数为（tang, song, ci）。唐诗: tang | 宋诗: song | 宋词: ci，不传递或空值则不进行过滤

searchType (string, 可选): 关键字条件匹配的内容，可选参数为（title, author, content, all）。标题或词牌名: title | 作者: author | 诗歌或词的内容: content | 匹配以上所有: all，不传递则默认值为 all

返回字段:

DataStatus.StatusCode: 接口返回状态码

DataStatus.StatusDescription: 接口返回状态说明

DataStatus.ResponseDateTime: 接口数据返回时间

DataStatus.DataTotalCount: 此条件下的总数据量，一般用于分页计算

DataStatus.RequestParameter: 请求参数，一般用于调试

Data.Title: 诗歌标题或宋词词牌名

Data.Author: 作者名

Data.Content: 诗歌或词的内容，格式为 string 数组

Data.Type: 类型，分为：唐诗 | 宋诗 | 宋词

HTTP 状态码:

200 接口正常响应: 业务状态码请结合响应体中的状态字段判断。

400 请求参数错误: 参数缺失、格式错误或非法组合。

401 鉴权失败: 缺少 APPKEY 或 APPKEY 无效。

403 无权限或额度不可用: 订单到期、权限不足或剩余额度不可用。

404 资源不存在: 请求路径不存在。

405 请求方法不允许: 请求方法与接口定义不匹配。

415 请求内容类型不支持: 文件上传或请求体格式不符合要求。

429 请求频率超限: 触发接口或网关限流策略。

500 服务内部异常: 服务执行异常，请联系技术支持。

502 上游依赖异常: 上游服务响应异常或暂不可用。

业务状态码:

100 正常返回: 暂无说明

101 参数错误: 暂无说明

102 请求频率受限: 每秒请求不能超过 100 次

103 账号欠费: 暂无说明

104 APPKEY 错误: 请检查传递的 APPKEY 是否为开发者中心获取到的值

110 接口响应错误: 暂无说明

接口特性:

中文全数量级唐诗宋诗宋词数据；

关键字可对标题、作者与内容进行模糊匹配；

总计近 40 万条数据；

数据持续更新与维护；

全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；

全面兼容 Apple ATS；

全国多节点 CDN 部署；

接口极速响应，多台服务器构建 API 接口负载均衡。

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

示例

{
  "DataStatus": {
    "StatusCode": 0,
    "StatusDescription": "string",
    "ResponseDateTime": "string",
    "DataTotalCount": 0,
    "RequestParameter": "string"
  },
  "Data": {
    "Title": "string",
    "Author": "string",
    "Content": [
      "string"
    ],
    "Type": "string"
  }
}