• API 功能

    • 按关键词检索诗词标题,便于查找相关作品;
    • 标题检索模式支持词牌名,便于整理同一词牌的宋词;
    • 按作者检索,便于查看作者作品;
    • 按正文关键词检索,便于查找包含指定字词的诗词;
    • 可联合检索标题、作者和正文;
    • 可选择唐诗、宋诗或宋词分类;
    • 正文关键词保留现有简繁兼容检索;
    • 正文以段落数组返回,保留原文分段;
    • 支持分页读取,每页可选择 1–20 条;
    • 返回筛选后的作品总数,便于构建检索分页;
    • 不传关键词时可分页浏览作品目录;
    • 默认最大 QPS:5,可在开发者中心自助升级,年付订单接口调用次数不限。
    • 接口调用状态与状态监控
  • API 文档

    接口地址: https://api.gugudata.com/text/chinesepoem

    返回格式: application/json; charset=utf-8

    请求方式: GET

    请求协议: HTTPS

    请求示例: https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all

    数据预览: https://www.gugudata.com/preview/chinesepoem

    接口测试:  https://api.gugudata.com/text/chinesepoem/demo

    OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

    请求参数(GET 请求方式可参见下方示例代码)

    参数名 参数类型 是否必须 默认值 备注
    appkey string 是 无 付费后获取的 APPKEY
    keywords string 否 无 可选;不传或空值时浏览目录。按 searchtype 进行字面包含匹配,特殊符号不作为正则表达式执行。
    pagesize integer 否 10 分页参数,每页总条数,取值范围在 1 ~ 20 之间
    pagenumber integer 否 1 分页参数,第几页
    type string 否 无 数据分类,可选参数为(tang, song, ci)。唐诗: tang | 宋诗: song | 宋词: ci,不传递或空值则不进行过滤
    searchtype string 否 all 默认 all。title 匹配标题或词牌;author 匹配作者;content 保留正文及词牌匹配;all 联合匹配作者、标题、正文和词牌;未知值沿用 all。只有正文匹配补充对应繁体形式。

    返回参数

    参数名 参数类型 备注
    DataStatus.StatusCode integer 业务状态码:100 成功;501 参数错误;502 请求频率受限;503 商品权益过期;504 APPKEY 无效;505 调用额度不足;901 处理或依赖失败。
    DataStatus.StatusDescription string 接口返回状态说明
    DataStatus.ResponseDateTime string 接口数据返回时间
    DataStatus.DataTotalCount integer 此条件下的总数据量,一般用于分页计算
    DataStatus.RequestParameter string 真实可读的 keywords/pagesize/pagenumber/type/searchtype,不包含鉴权凭据;Demo 与烽火样例对应。
    Data[].Title string 诗歌标题或宋词词牌名
    Data[].Author string 作者名
    Data[].Content array 诗歌或词的内容,格式为 string 数组
    Data[].Type string 类型,分为:唐诗 | 宋诗 | 宋词

    响应示例(真实数据节选)

    接口数据预览

    仅展示部分示例数据,数组最多展示 3 项,长内容已省略;完整数据请调用接口获取。

    {
      "DataStatus": {
        "RequestParameter": "keywords=烽火&pagesize=10&pagenumber=1&type=&searchtype=all",
        "StatusCode": 100,
        "StatusDescription": "请求成功。",
        "ResponseDateTime": "2026-10-28 22:22:34.771",
        "DataTotalCount": 244
      },
      "Data": [
        {
          "Title": "贺新凉・贺新郎",
          "Author": "吴泳",
          "Content": [
            "额扣龙墀苦。",
            "对南宫、春风侍女,掉头不顾。",
            "烽火连营家万里,漠漠黄沙吹雾。"
          ],
          "Type": "宋词"
        },
        {
          "Title": "水调歌头",
          "Author": "吴渊",
          "Content": [
            "太白已仙去,诗骨此山藏。",
            "胸中锦绣如屋,都乞与东皇。",
            "碎翦杏花千树,浓抹胭脂万点,妖艳断人肠。"
          ],
          "Type": "宋词"
        },
        {
          "Title": "水调歌头",
          "Author": "崔与之",
          "Content": [
            "万里云间戍,立马剑门关。",
            "乱山极目无际,直北是长安。",
            "人苦百年涂炭,鬼哭三边锋镝,天道久应还。"
          ],
          "Type": "宋词"
        }
      ]
    }
  • 鉴权方式

    接口支持以下 AppKey 传递方式,任选一种即可;已有请求示例、Postman 集合和历史代码仍可继续使用原来的 appkey 参数方式。

    传输载体 参数 示例 说明
    HTTP Header X-GUGUDATA-APPKEY X-GUGUDATA-APPKEY: YOUR_APPKEY 推荐方式,适合服务端接入和统一封装。
    HTTP Header X-API-Key X-API-Key: YOUR_APPKEY 通用 API Key Header,便于和常见 API 客户端集成。
    HTTP Header Authorization Authorization: Bearer YOUR_APPKEY 适合 OpenAI 兼容接口或 Bearer Token 风格客户端。
    Query 参数 appkey ?appkey=YOUR_APPKEY 兼容现有示例、Postman 集合、浏览器调试和历史代码。

    部分历史 POST 接口仍兼容表单或 JSON body 中的 appkey;新接入建议优先使用 Header 或 Query 参数。

  • 接口常见 HTTP 响应状态码

    以下为接口调用中常见的 HTTP 传输层状态码,不等同于响应体内的业务状态码;完整状态码注册表以 IANA HTTP Status Code Registry 为准。

    状态码 状态码解释 备注
    200 请求成功 HTTP 请求已成功处理;业务状态请结合响应体中的自定义业务码判断。
    201 资源已创建 创建类接口请求成功,并已生成对应资源。
    202 请求已接受 请求已被接受处理,结果可能异步完成。
    204 无响应内容 请求成功但响应体为空,适用于无需返回数据的操作。
    400 请求参数错误 请求参数缺失、格式错误或参数组合不合法。
    401 认证失败 缺少、无效或未通过认证的访问凭证(如 AppKey)。
    403 无权限访问 订单到期、权限不足或接口额度不可用。
    404 资源不存在 请求路径不存在。
    405 请求方法不允许 当前路径不支持该 HTTP 方法。
    408 请求超时 客户端请求在服务端等待时间内未完成,可稍后重试。
    409 请求冲突 请求与当前资源状态冲突,调整参数或业务状态后重试。
    413 请求内容过大 上传文件或请求体超过接口限制。
    414 请求地址过长 请求 URL 超过服务端可处理长度,建议减少查询参数或改用 POST。
    415 请求内容类型不支持 上传或请求体的内容类型不符合接口要求。
    422 请求语义错误 请求格式正确,但参数取值、语义或业务约束无法处理。
    429 请求频率受限 默认按来源 IP 限速,单 IP 最多 5 QPS,可满足常规业务调用。超出限制时接口会返回 429 请求频率受限;已购买接口订单可加购 10 QPS 扩展。
    431 请求头过大 请求头字段过大或过多,建议精简 Header 后重试。
    500 服务器内部错误 服务端处理异常,请稍后重试。
    502 服务暂时不可用 请稍后重试。
    503 服务暂时不可用 请稍后重试。
    504 请求超时 请稍后重试。
  • 接口自定义业务状态码

    业务状态码 业务状态码解释 备注
    100 成功 HTTP 200
    501 参数错误 HTTP 400
    901 处理、依赖失败或超时 HTTP 503
    502 请求频率限制 HTTP 429
    503 权益过期 HTTP 403
    504 凭据缺失或无效、无商品权限、鉴权服务不可用;结合状态判断 HTTP 401/403/503
    505 调用额度不足 HTTP 403
  • 请求示例代码

    curl --location --request GET 'https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all'
    #include <curl/curl.h>
    
    int main(void) {
      CURL *curl = curl_easy_init();
      if (curl) {
        curl_easy_setopt(curl, CURLOPT_URL, "https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all");
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
        curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
        CURLcode res = curl_easy_perform(curl);
        (void)res;
        curl_easy_cleanup(curl);
      }
      return 0;
    }
    
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Net.Http;
    
    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Get, "https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all");
    var response = client.SendAsync(request).Result;
    Console.WriteLine(response.Content.ReadAsStringAsync().Result);
    
    package main
    
    import (
      "fmt"
      "io"
      "net/http"
    )
    
    func main() {
      url := "https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all"
      req, err := http.NewRequest("GET", url, nil)
      if err != nil {
        fmt.Println(err)
        return
      }
      res, err := http.DefaultClient.Do(req)
      if err != nil {
        fmt.Println(err)
        return
      }
      defer res.Body.Close()
      body, err := io.ReadAll(res.Body)
      if err != nil {
        fmt.Println(err)
        return
      }
      fmt.Println(string(body))
    }
    
    OkHttpClient client = new OkHttpClient().newBuilder().build();
    Request request = new Request.Builder()
      .url("https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all")
      .method("GET", null)
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
    
    $.ajax({
      url: "https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all",
      method: "GET",
    }).done(function (response) {
      console.log(response);
    });
    
    const https = require("node:https");
    
    const url = "https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all";
    const request = https.request(url, { method: "GET", headers: {  } }, handleResponse);
    request.on("error", console.error);
    request.end();
    
    function handleResponse(response) {
      const chunks = [];
      response.on("data", function (chunk) {
        chunks.push(chunk);
      });
      response.on("end", function () {
        console.log(Buffer.concat(chunks).toString("utf8"));
      });
    }
    
    #import <Foundation/Foundation.h>
    
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all"]];
    [request setHTTPMethod:@"GET"];
    NSURLSessionDataTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
      if (error) {
        NSLog(@"%@", error);
        return;
      }
      NSLog(@"%@", [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
    }];
    [task resume];
    
    <?php
    $curl = curl_init();
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_CUSTOMREQUEST => "GET",
    ));
    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;
    
    import requests
    
    url = "https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all"
    response = requests.request("GET", url)
    print(response.text)
    
    require "uri"
    require "net/http"
    
    url = URI("https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all")
    https = Net::HTTP.new(url.host, url.port)
    https.use_ssl = true
    request = Net::HTTP::Get.new(url)
    response = https.request(request)
    puts response.read_body
    
    import Foundation
    
    let semaphore = DispatchSemaphore(value: 0)
    var request = URLRequest(url: URL(string: "https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=%e7%83%bd%e7%81%ab&pagesize=10&pagenumber=1&type=&searchtype=all")!, timeoutInterval: .infinity)
    request.httpMethod = "GET"
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
      defer { semaphore.signal() }
      guard let data = data else {
        print(String(describing: error))
        return
      }
      print(String(data: data, encoding: .utf8)!)
    }
    task.resume()
    semaphore.wait()
    
  • 常见问题 Q&A

    • Q: 如何完成第一次 API 调用?

      A: 先确认当前接口的请求方法、必填参数和成功状态,再使用对应产品的 AppKey 发起请求;以实际响应中的业务状态判断结果。 查看接入指南

    • Q: 如何保证请求时 AppKey 的安全性?

      A: 在开发者中心的 APP KEY 管理页面复制对应产品的 AppKey,并保存在服务端环境变量或密钥管理服务中。不要写入网页、App 客户端、公开仓库或日志。

    • Q: 接口可以用于哪些开发语言?

      A: Java、Python、Node.js、PHP、Go、C#、Swift、Kotlin 等支持 HTTP 请求的语言均可接入;也可以通过 OpenAPI、Postman 或 Apifox 查看和调试接口。

    • Q: 请求失败或超时后可以重试吗?

      A: 先区分 HTTP 状态与业务错误。参数、鉴权和权限错误应修正后再请求;超时并不表示服务端未执行,重试前需确认接口是否会重复计费或产生副作用。 查看接入指南

    • Q: 接口的性能可以保证吗?

      A: 实际响应时间受接口类型、参数和网络环境影响。请按当前套餐的 QPS 控制并发,生产接入前完成联调与容量评估。

    • Q: 数据多久更新?

      A: 不同接口按各自的数据周期更新,请以当前详情页的更新时间、更新频率及字段说明为准;不要将一次请求时间视为数据更新时间。

  • 服务协议与免责声明

    购买或使用 GuGuData API 服务前,请充分阅读服务协议、免责声明与数据合规声明。相关页面均支持在浏览器中快速导出 PDF,便于内部归档、评审和合规留存。

  • 技术支持

    技术支持邮箱:
    support@gugudata.com
    企业微信客服:
    联系客服
  • 专业软件开发与系统工程服务

    GuGuData 官方认证工程合作伙伴,专注企业级数据接口集成、AI 工程化与大规模数据处理。团队深度理解 GuGuData 数据接口体系,具备海量数据采集、治理、检索与高并发接口服务经验,可围绕业务场景构建 AI Agent、MCP 接入、智能工作流和生产级数据应用,让数据能力稳定进入现有流程、内部平台和核心业务系统。

    了解工程服务