# 百万中国对联数据 API 接口


百万中国对联数据 API 接口

支持全文检索级别。

![gugudata_api_cover](https://static.gugudata.com/api_couplet.jpg)

# 1. 产品功能

- 中文全数量级历史对联数据；
- 百万级数据；
- 数据持续更新与维护；
- 全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；
- 全面兼容 Apple ATS；
- 全国多节点 CDN 部署；
- 接口极速响应，多台服务器构建 API 接口负载均衡。

# 2. API 文档

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

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

**请求方式:** GET

**请求协议:** HTTPS

**请求示例:** https://api.gugudata.com/text/couplet?appkey=YOUR_APPKEY&keywords=YOUR_VALUE&pagesize=10&pagenumber=1

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

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



# 3. 请求参数

|   参数名   | 参数类型 | 是否必须 |   默认值    |                     备注                      |
| :--------: | :------: | :------: | :---------: | :-------------------------------------------: |
|   appkey   |  string  |    是    | YOUR_APPKEY |              付费后获取的 APPKEY              |
|  keywords  |  string  |    否    | YOUR_VALUE  |                  查询关键字                   |
|  pagesize  |   int    |    是    |     10      | 分页参数，每页总条数，取值范围在 10 ~ 50 之间 |
| pagenumber |   int    |    是    |      1      |               分页参数，第几页                |

# 4. 返回参数

|            参数名            | 参数类型 |                 备注                 |
| :--------------------------: | :------: | :----------------------------------: |
|    DataStatus.StatusCode     |   int    |            接口返回状态码            |
| DataStatus.StatusDescription |  string  |           接口返回状态说明           |
| DataStatus.ResponseDateTime  |  string  |           接口数据返回时间           |
|  DataStatus.DataTotalCount   |   int    | 此条件下的总数据量，一般用于分页计算 |
| DataStatus.RequestParameter  |  string  |        请求参数，一般用于调试        |
|          Data.First          |  string  |                 上联                 |
|         Data.Second          |  string  |                 下联                 |