获取文章列表

HTTP request 分页获取 Web3 内容列表。列表接口不返回文章正文。

• GET /api/v3/content/articles/list

权重(IP): 1

请求头

请求头	是否必须	描述
locale	否	内容语言，默认 en_US。可选值：ar_AR、az_AZ、de_DE、en_US、es_419、es_AR、es_ES、fa_IR、fr_FR、in_ID、it_IT、ja_JP、pl_PL、pt_BR、pt_PT、ru_RU、uk_UK、vi_VN、zh_CN、zh_TW。

请求参数

参数名	类型	是否必须	适用板块	描述
section	String	是	全部	一次仅支持一个值：wiki、news、learn、questions。
category	String	否	wiki、news	分类过滤，最长 64 个字符；用于 news 时与 categoryFilter 互斥。
categoryFilter	String	否	news	排除指定分类，最长 64 个字符；与 category 互斥。
tagName	String	否	全部	按关联标签名称过滤。
title	String	否	wiki、news、questions	标题模糊搜索，最长 200 个字符。
prioritySort	Boolean	否	news	是否按优先级排序，默认 false。
level	String	否	learn	Beginner、Intermediate、Advanced；与 excludeLevel 互斥。
excludeLevel	String	否	learn	排除一个学习等级；与 level 互斥。
excludeDocumentId	String	否	questions	排除指定 documentId，通常用于相关推荐查询。
excludeContentKey	String	否	questions	排除 contentKey。
withCount	Boolean	否	全部	是否返回 total 和 pages，默认 false。
page	Integer	否	全部	页码，从 1 开始，默认 1。
pageSize	Integer	否	全部	每页数量，默认 25，最大 200。
populateThumbnail	Boolean	否	wiki、news、learn	是否返回 thumbnail，默认 false；questions 会忽略该参数。
populateTagLists	Boolean	否	全部	是否返回 tagLists，默认 false。
populateCoins	Boolean	否	全部	是否返回 coinsMaps，默认 false。

请求示例

curl "https://api-spot.weex.com/api/v3/content/articles/list?section=news&categoryFilter=events&prioritySort=true&page=1&pageSize=10&withCount=true&populateThumbnail=true&populateTagLists=true&populateCoins=true" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*******" \
   -H "ACCESS-PASSPHRASE:*****" \
   -H "ACCESS-TIMESTAMP:1659076670000" \
   -H "locale: zh_CN" \
   -H "Content-Type: application/json"

返回参数

字段名	类型	描述
total	Long	总记录数，withCount=false 时为 null。
page	Integer	当前页码。
pageSize	Integer	每页数量。
pages	Integer	总页数，withCount=false 时为 null。
hasNextPage	Boolean	是否存在下一页。
items	ArticleListItem[]	文章列表。

ArticleListItem

字段名	类型	适用板块	描述
id	Long	全部	内容 ID。
documentId	String	全部	文档 ID。
v4Id	String	全部	兼容旧版本数据的 ID。
section	String	全部	wiki、news、learn、questions。
title	String	全部	当前语言标题。
summary	String	wiki、news、questions	内容摘要，learn 为 null。
contentKey	String	全部	内容标识。
enabled	Boolean	wiki、news、questions	是否启用，learn 为 null。
enabledDate	Long	wiki、news、questions	启用时间，UTC 毫秒时间戳；learn 为 null。
category	String	wiki、news	内容分类。
imgCategory	String	wiki	Wiki 图片分类。
link	String	news	外部来源链接。
sourceSite	String	news	来源站点。
outerPic	String	news	外部来源图片。
originalSourceUrl	String	news	原始来源 URL。
priority	Integer	news	新闻优先级。
date	Long	learn	学院内容日期，UTC 毫秒时间戳。
level	String	learn	Beginner、Intermediate、Advanced。
outerId	String	全部	外部内容 ID。
outerLocaleId	Long	wiki、learn、questions	外部语言 ID，news 为 null。
sourceLang	String	wiki、learn、questions	来源语言，news 为 null。
titleEn	String	全部	英文标题。
translation	Boolean	wiki、learn、questions	翻译标识，news 为 null。
translationStatus	String	wiki、learn、questions	翻译状态，news 为 null。
thumbnail	Object	wiki、news、learn	板块不支持、未请求或无缩略图时为 null。
tagLists	Array	全部	未请求时为 null；请求后没有标签时为空数组。
coinsMaps	Array	全部	未请求时为 null；请求后没有币种时为空数组。
publishedAt	Long	全部	发布时间，UTC 毫秒时间戳。
createdAt	Long	全部	创建时间，UTC 毫秒时间戳。
updatedAt	Long	全部	更新时间，UTC 毫秒时间戳。

返回示例

{
  "total": 8102,
  "page": 1,
  "pageSize": 10,
  "pages": 811,
  "hasNextPage": true,
  "items": [
    {
      "id": 1811667,
      "documentId": "nixq62735vbptclw9y0xti6f",
      "v4Id": null,
      "section": "news",
      "title": "市场新闻标题",
      "summary": "市场新闻摘要。",
      "contentKey": null,
      "enabled": true,
      "enabledDate": 1781062934160,
      "category": "news-flash",
      "imgCategory": null,
      "link": "https://example.com/article",
      "sourceSite": "rootData",
      "outerPic": null,
      "originalSourceUrl": "https://example.com/article",
      "priority": null,
      "date": null,
      "level": null,
      "outerId": "rootData_2270427",
      "outerLocaleId": null,
      "sourceLang": null,
      "titleEn": "Market news title",
      "translation": null,
      "translationStatus": null,
      "thumbnail": null,
      "tagLists": [],
      "coinsMaps": [],
      "publishedAt": 1781062922400,
      "createdAt": 1781062922391,
      "updatedAt": 1781062935084
    }
  ]
}