Get Article List by Coin

HTTP request Returns a paginated Web3 content list associated with a coin.

GET /api/v3/content/articles/listByCoin

Weight(IP): 1

Request headers

Header	Required	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`.

Request parameters

Parameter	Type	Required	Applies to	Description
`section`	String	Yes	All	One content section: `wiki`, `news`, `learn`, or `questions`.
`symbol`	String	Conditional	All	Coin symbol, for example `BTC`. At least one of `symbol` and `slug` is required.
`slug`	String	Conditional	All	Coin slug, for example `btc`. At least one of `symbol` and `slug` is required.
`startEnableDate`	String	No	`news`	Inclusive lower bound of `enabledDate`, as a Unix timestamp in seconds or milliseconds. Ignored for other sections.
`endEnableDate`	String	No	`news`	Inclusive upper bound of `enabledDate`, as a Unix timestamp in seconds or milliseconds. When omitted, results do not go beyond the current time. Ignored for other sections.
`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	Number of 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`.

Request example

curl "https://api-spot.weex.com/api/v3/content/articles/listByCoin?section=learn&symbol=BTC&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"

Response parameters

Field	Type	Description
`total`	Long	Total records. May be `null` when `withCount=false`.
`page`	Integer	Current page number.
`pageSize`	Integer	Page size.
`pages`	Integer	Total pages. May be `null` when `withCount=false`.
`hasNextPage`	Boolean	Whether another page is available.
`items`	ArticleListItem[]	Article items. Fields are documented in Get Article List.

Article bodies are not returned. Every item contains the complete 30-field ArticleListItem union documented in Get Article List. Fields that do not apply to the selected section are returned as null; they are not omitted.

Response example

{
  "total": 154,
  "page": 1,
  "pageSize": 10,
  "pages": 16,
  "hasNextPage": true,
  "items": [
    {
      "id": 1714,
      "documentId": "vvcry6rt2d8bt5e4kgaaxkv7",
      "v4Id": null,
      "section": "learn",
      "title": "What Is Bitcoin?",
      "summary": null,
      "level": "Beginner",
      "contentKey": "learn-bitcoin",
      "titleEn": "What Is Bitcoin?",
      "thumbnail": null,
      "tagLists": [],
      "coinsMaps": [
        {
          "id": 1,
          "documentId": "btc-coin-map",
          "slug": "btc",
          "symbol": "BTC",
          "name": "Bitcoin",
          "icon": "https://example.com/btc.png",
          "type": "Tokens",
          "locale": "en_US"
        }
      ],
      "publishedAt": 1780993501641,
      "createdAt": 1780993356022,
      "updatedAt": 1780993519507
    }
  ]
}