
# Get Article List

**HTTP request** Returns a paginated list of Web3 content. Article bodies are not included in list responses.

- **GET** ```/api/v3/content/articles/list```

Weight(IP): 1

<div class='api-content-wrap'>
<div>

<strong>Request headers</strong>

| Header | <span style={{whiteSpace: 'nowrap'}}>Required</span> | Description |
|:---|:---|:---|
| `locale` | No | Content locale. Default: `en_US`. Supported values: `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`. |

<strong>Request parameters</strong>

| Parameter | Type | <span style={{whiteSpace: 'nowrap'}}>Required</span> | Applies to | Description |
|:---|:---|:---|:---|:---|
| `section` | String | Yes | All | One value: `wiki`, `news`, `learn`, or `questions`. |
| `category` | String | No | `wiki`, `news` | Category filter, maximum 64 characters. For `news`, it is mutually exclusive with `categoryFilter`. |
| `categoryFilter` | String | No | `news` | Excludes the specified categories, maximum 64 characters. Mutually exclusive with `category`. |
| `tagName` | String | No | All | Filters by associated tag name. |
| `title` | String | No | `wiki`, `news`, `questions` | Fuzzy title search, maximum 200 characters. |
| `prioritySort` | Boolean | No | `news` | Sorts by priority. Default: `false`. |
| `level` | String | No | `learn` | `Beginner`, `Intermediate`, or `Advanced`. Mutually exclusive with `excludeLevel`. |
| `excludeLevel` | String | No | `learn` | Excludes one learning level. Mutually exclusive with `level`. |
| `excludeDocumentId` | String | No | `questions` | Excludes one document ID, typically for related-content queries. |
| `excludeContentKey` | String | No | `questions` | Excludes contentKey. |
| `withCount` | Boolean | No | All | Whether to return `total` and `pages`. Default: `false`. |
| `page` | Integer | No | All | Page number, starting from 1. Default: `1`. |
| `pageSize` | Integer | No | All | Items per page. Default: `25`; maximum: `200`. |
| `populateThumbnail` | Boolean | No | `wiki`, `news`, `learn` | Whether to return `thumbnail`. Default: `false`. Ignored for `questions`. |
| `populateTagLists` | Boolean | No | All | Whether to return `tagLists`. Default: `false`. |
| `populateCoins` | Boolean | No | All | Whether to return `coinsMaps`. Default: `false`. |

</div>
<div class='api-align'>
  <div class='code-wrap'>

<strong>Request example</strong>

```powershell
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: en_US" \
   -H "Content-Type: application/json"
```

  </div>
</div>
</div>

<div class='api-content-wrap'>
<div>

<strong>Response parameters</strong>

| Field | Type | Description |
|:---|:---|:---|
| `total` | Long | Total records. `null` when `withCount=false`. |
| `page` | Integer | Current page number. |
| `pageSize` | Integer | Page size. |
| `pages` | Integer | Total pages. `null` when `withCount=false`. |
| `hasNextPage` | Boolean | Whether another page is available. |
| `items` | ArticleListItem[] | Article items. |

<strong>ArticleListItem</strong>

| Field | Type | Applies to | Description |
|:---|:---|:---|:---|
| `id` | Long | All | Content ID. |
| `documentId` | String | All | Document ID. |
| `v4Id` | String | All | Legacy-compatible content ID. |
| `section` | String | All | `wiki`, `news`, `learn`, or `questions`. |
| `title` | String | All | Localized title. |
| `summary` | String | `wiki`, `news`, `questions` | Localized summary. `null` for `learn`. |
| `contentKey` | String | All | Content key. |
| `enabled` | Boolean | `wiki`, `news`, `questions` | Whether the content is enabled. `null` for `learn`. |
| `enabledDate` | Long | `wiki`, `news`, `questions` | Enable time in UTC milliseconds. `null` for `learn`. |
| `category` | String | `wiki`, `news` | Content category. |
| `imgCategory` | String | `wiki` | Wiki image category. |
| `link` | String | `news` | External source link. |
| `sourceSite` | String | `news` | Source site. |
| `outerPic` | String | `news` | External source image. |
| `originalSourceUrl` | String | `news` | Original source URL. |
| `priority` | Integer | `news` | News priority. |
| `date` | Long | `learn` | Learning content date in UTC milliseconds. |
| `level` | String | `learn` | `Beginner`, `Intermediate`, or `Advanced`. |
| `outerId` | String | All | External content ID. |
| `outerLocaleId` | Long | `wiki`, `learn`, `questions` | External locale ID. `null` for `news`. |
| `sourceLang` | String | `wiki`, `learn`, `questions` | Source language. `null` for `news`. |
| `titleEn` | String | All | English title. |
| `translation` | Boolean | `wiki`, `learn`, `questions` | Translation flag. `null` for `news`. |
| `translationStatus` | String | `wiki`, `learn`, `questions` | Translation status. `null` for `news`. |
| `thumbnail` | Object | `wiki`, `news`, `learn` | `null` when unsupported, not requested, or absent. |
| `tagLists` | Array | All | `null` when not requested; an empty array when requested but no tags exist. |
| `coinsMaps` | Array | All | `null` when not requested; an empty array when requested but no coins exist. |
| `publishedAt` | Long | All | Publication time in UTC milliseconds. |
| `createdAt` | Long | All | Creation time in UTC milliseconds. |
| `updatedAt` | Long | All | Update time in UTC milliseconds. |

</div>
<div class='api-align'>
  <div class='code-wrap'>

<strong>Response example</strong>

```json
{
  "total": 8102,
  "page": 1,
  "pageSize": 10,
  "pages": 811,
  "hasNextPage": true,
  "items": [
    {
      "id": 1811667,
      "documentId": "nixq62735vbptclw9y0xti6f",
      "v4Id": null,
      "section": "news",
      "title": "Data: 12,000 ETH withdrawn from Poloniex",
      "summary": "A market news 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": "Data: 12,000 ETH withdrawn from Poloniex",
      "translation": null,
      "translationStatus": null,
      "thumbnail": null,
      "tagLists": [],
      "coinsMaps": [],
      "publishedAt": 1781062922400,
      "createdAt": 1781062922391,
      "updatedAt": 1781062935084
    }
  ]
}
```

  </div>
</div>
</div>
