Content Endpoints

Endpoint

Download Schema

Get Article List

Get Article List.

GET

/api/v3/content/articles/list

https://api-spot.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight1

Get Article List › query Parameters

section

string · required

One value: wiki, news, learn, or questions.

category

string

Category filter, maximum 64 characters. For news, it is mutually exclusive with categoryFilter.

categoryFilter

string

Excludes the specified categories, maximum 64 characters. Mutually exclusive with category.

tagName

string

Filters by associated tag name.

title

string

Fuzzy title search, maximum 200 characters.

prioritySort

boolean

Sorts by priority. Default: false.

level

string

Beginner, Intermediate, or Advanced. Mutually exclusive with excludeLevel.

excludeLevel

string

Excludes one learning level. Mutually exclusive with level.

excludeDocumentId

string

Excludes one document ID, typically for related-content queries.

excludeContentKey

string

Excludes contentKey.

withCount

boolean

Whether to return total and pages. Default: false.

page

integer

Page number, starting from 1. Default: 1.

pageSize

integer

Items per page. Default: 25; maximum: 200.

populateThumbnail

boolean

Whether to return thumbnail. Default: false. Ignored for questions.

populateTagLists

boolean

Whether to return tagLists. Default: false.

populateCoins

boolean

Whether to return coinsMaps. Default: false.

Get Article List › Responses

200

Successful response

total

integer

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.

object[]

Article items.

GET/api/v3/content/articles/list

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"

{
  "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
    }
  ]
}

json

application/json

Get Article List by Coin

Get Article List by Coin.

GET

/api/v3/content/articles/listByCoin

https://api-spot.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight1

Get Article List by Coin › query Parameters

section

string · required

One content section: wiki, news, learn, or questions.

symbol

string

Coin symbol, for example BTC. At least one of symbol and slug is required.

slug

string

Coin slug, for example btc. At least one of symbol and slug is required.

startEnableDate

string

Inclusive lower bound of enabledDate, as a Unix timestamp in seconds or milliseconds. Ignored for other sections.

endEnableDate

string

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

Whether to return total and pages. Default: false.

page

integer

Page number, starting from 1. Default: 1.

pageSize

integer

Number of items per page. Default: 25; maximum: 200.

populateThumbnail

boolean

Whether to return thumbnail. Default: false. Ignored for questions.

populateTagLists

boolean

Whether to return tagLists. Default: false.

populateCoins

boolean

Whether to return coinsMaps. Default: false.

Get Article List by Coin › Responses

200

Successful response

total

integer

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.

object[]

Article items. Fields are documented in Get Article List.

GET/api/v3/content/articles/listByCoin

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"

{
  "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
    }
  ]
}

json

application/json

Get Article Detail

Get Article Detail.

GET

/api/v3/content/articles/detail

https://api-spot.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight1

Get Article Detail › query Parameters

section

string · required

One value: wiki, news, learn, or questions.

documentId

string

Document ID. Takes precedence when both IDs are supplied.

v4Id

string

Legacy-compatible ID. At least one of documentId and v4Id is required.

populateThumbnail

boolean

Whether to return thumbnail. Default: false. Ignored for questions.

populateTagLists

boolean

Whether to return tagLists. Default: false. Ignored for news.

populateCoins

boolean

Whether to return coinsMaps. Default: false.

Get Article Detail › Responses

200

Successful response

id

integer

Content ID.

documentId

string

Document ID.

v4Id

string | null

Legacy-compatible content ID.

section

string

wiki, news, learn, or questions.

title

string

Localized title.

summary

string

Localized summary. null for learn.

contentKey

string | null

Content key.

enabled

boolean

Whether the content is enabled. null for learn.

enabledDate

integer

Enable time in UTC milliseconds. null for learn.

category

string

Content category.

imgCategory

string

Wiki image category.

link

string | null

External source link.

sourceSite

string | null

Source site.

outerPic

string | null

External source image.

originalSourceUrl

string | null

Original source URL.

priority

integer | null

News priority.

date

integer | null

Learning content date in UTC milliseconds.

level

string | null

Beginner, Intermediate, or Advanced.

outerId

string

External content ID.

outerLocaleId

integer

External locale ID. null for news.

sourceLang

string | null

Source language. null for news.

titleEn

string

English title.

translation

boolean

Translation flag. null for news.

translationStatus

string

Translation status. null for news.

thumbnail

object | null

null when unsupported, not requested, or absent.

tagLists

array

null when not requested; an empty array when requested but no tags exist.

coinsMaps

array

null when not requested; an empty array when requested but no coins exist.

publishedAt

integer

Publication time in UTC milliseconds.

createdAt

integer

Creation time in UTC milliseconds.

updatedAt

integer

Update time in UTC milliseconds.

body

string

HTML body. The content field from learn is mapped to body.

articleUrl

string

WEEX article URL generated by the server.

total

integer

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

object[]

Article items.

GET/api/v3/content/articles/detail

curl "https://api-spot.weex.com/api/v3/content/articles/detail?section=wiki&documentId=p9k2hraavuh05kfwq4ctsz84&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"

{
  "id": 4960955,
  "documentId": "p9k2hraavuh05kfwq4ctsz84",
  "v4Id": null,
  "section": "wiki",
  "title": "iShares Core MSCI EAFE Tokenized ETF (Ondo) Price Prediction",
  "summary": "This article provides a market outlook and price prediction for IEFAON.",
  "contentKey": null,
  "enabled": true,
  "enabledDate": 1780993402765,
  "category": "price-prediction",
  "imgCategory": "Price Prediction",
  "link": null,
  "sourceSite": null,
  "outerPic": null,
  "originalSourceUrl": null,
  "priority": null,
  "date": null,
  "level": null,
  "outerId": "wordPress_wiki_130881263710491",
  "outerLocaleId": 130881263710491,
  "sourceLang": null,
  "titleEn": "iShares Core MSCI EAFE Tokenized ETF (Ondo) Price Prediction",
  "translation": true,
  "translationStatus": "Translated",
  "thumbnail": null,
  "tagLists": [],
  "coinsMaps": [],
  "publishedAt": 1780993501641,
  "createdAt": 1780993356022,
  "updatedAt": 1780993519507,
  "body": "<p>This article provides a full analysis of the market outlook.</p>",
  "articleUrl": "https://www.weex.com/wiki/article/ishares-core-msci-eafe-tokenized-etf-ondo-price-prediction-p9k2hraavuh05kfwq4ctsz84"
}

json

application/json

Get Latest Banner

Get Latest Banner.

GET

/api/v3/content/banners/latest

https://api-spot.weex.com

Request weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.

Learn more in the Access Restrictions section.

IP weight1

Get Latest Banner › query Parameters

type

string · required

Banner type: News, Wiki, Learn main, Learn details, News details bottom, learn pop up, learn pop up detail, or News details text.

Get Latest Banner › Responses

200

Successful response

id

integer

Banner ID.

documentId

string

Document ID.

title

string

Banner title.

description

string

Banner description.

cta

string

Call-to-action text.

link

string

Target URL.

type

string

Banner type.

object

Banner image metadata. Omitted when no image exists.

publishedAt

integer

Publication time in UTC milliseconds.

createdAt

integer

Creation time in UTC milliseconds.

updatedAt

integer

Update time in UTC milliseconds.

GET/api/v3/content/banners/latest

curl "https://api-spot.weex.com/api/v3/content/banners/latest?type=News" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*******" \
   -H "ACCESS-PASSPHRASE:*****" \
   -H "ACCESS-TIMESTAMP:1659076670000" \
   -H "locale: en_US" \
   -H "Content-Type: application/json"

{
  "id": 1001,
  "documentId": "banner-news-latest",
  "title": "Latest Crypto News",
  "description": "Stay updated with the latest Web3 market news.",
  "cta": "Read more",
  "link": "https://www.weex.com/news",
  "type": "News",
  "thumbnail": {
    "id": 9001,
    "documentId": "banner-image-doc",
    "name": "news-banner.png",
    "url": "https://example.com/news-banner.png",
    "width": 1200,
    "height": 480,
    "mime": "image/png",
    "size": 245.5
  },
  "publishedAt": 1780993501641,
  "createdAt": 1780993356022,
  "updatedAt": 1780993519507
}

json

application/json

Partner Endpoints