文档首页 / 用户中心设置 / 开放 API 字段字典

开放 API 字段字典

2026-10-13 …

通用约定

字段类型说明
code整数0=成功;出错时等于 HTTP 状态码
msg字符串人类可读提示,成功时为空
data对象业务数据
meta.api_version字符串当前为 v1
meta.generated_at整数服务端生成时间(Unix 秒)
meta.cache_ttl整数建议客户端缓存秒数

榜单 / 分类流 / 搜索 的记录结构

字段类型说明
id整数文章 ID
title字符串标题
url字符串绝对地址,可直接打开
category.id整数分类 ID
category.name字符串分类名,微博/好单还会带细分(如「微博线报-饮料-淘宝」)
price数字或 nullnull 表示该内容没有价格(与 0 元不同)。只有微博线报/好单线报/值得买有值
published_at整数发布时间(Unix 秒)
author字符串楼主/发报员
comments整数评论数(仅榜单与分类流)
content字符串正文纯文本。分类流始终返回;详情完整返回;榜单在 limit ≤ 50 时不返回
excerpt字符串纯文本摘要。文章分页列表最多 500 字
content_html字符串需传 with_html=1;仅文章详情或支持正文的 feed/rank/search 返回,经过展示处理与白名单清洗

正文 HTML 仅在相应接口传入 with_html=1 时返回;/api/v1/article 详情也支持该参数。所有 content_html 都经过展示态图片处理、危险标签/属性清洗和 4 MB 单次预算。

文章详情的 content 是纯文本;文章列表只返回 500 字以内的 excerpt,不会加载完整正文。详情单篇原始正文超过 8 MiB 时返回 413 content_too_large,不会静默截断。

同样地,不提供浏览量字段。榜单已按站内热度排好序,外部按返回顺序使用即可。

文章分页列表与详情

字段类型说明
id整数本站文章 ID
category对象id、name(详情另含 alias)
author字符串作者显示名
published_at / updated_at整数Unix 秒
comments整数评论数
excerpt字符串列表最多 500 字;详情也返回
content字符串详情正文纯文本
content_html字符串详情传 with_html=1 时返回的清洗后展示态 HTML

这两个端点只包含已公开的普通文章,不包含页面、草稿或审核内容。分页列表的 data 提供 page、limit、count、has_more 与 items。

值得买独立流(type=zdm)

它的字段与上表完全不同,因为数据来自另一个平台,结构本身就不一样:

字段类型说明
id字符串值得买的商品 ID
title字符串商品标题(通常已含价格)
url字符串站外地址,指向 smzdm.com
price数字或 null价格
brand字符串品牌
mall字符串商城名(京东、天猫超市、抖音商城…)
category_name字符串平台侧类目路径
pic字符串商品图
published_at整数入库时间(Unix 秒)

生活优惠的记录结构

字段说明
act_id活动 ID
act_name活动名
cate_name活动分类
desc简介
img / icon横幅图 / 小图标
start_date / end_date活动起止日期(YYYY-MM-DD)
h5活动直达链接