/caixin/channels/articles

POST /api/caixin/channels/articles

Price: 20 credits

List the articles of a Caixin (caixin.com) channel, newest first: headline, summary, byline, publication time, section, column, keywords, tags, images, audio and video files and related coverage with its summary, section and tags

How to use it

Pass a row url to caixin/articles for the free part of the article.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of articles to return, newest first (min: 1; max: 500)
• channel string required — Caixin channel page URL or numeric channel id (examples: "https://finance.caixin.com/", "https://economy.caixin.com/", "125"; minLength: 1)

Response

• @type string (default: "CaixinChannelArticle")
• id string required
• url string required
• summary string nullable
• byline string nullable
• published_at integer nullable
• channel_id string nullable
• channel_name string nullable
• channel_url string nullable
• section string nullable
• section_url string nullable
• column string nullable
• column_url string nullable
• category_ids array (default: [])
• keywords array (default: [])
• tags array (default: [])
  • @type string (default: "CaixinTag")
  • id string nullable
  • name string required
• image string nullable
• images array (default: [])
• audio_url string nullable
• video_url string nullable
• related array (default: [])
  • @type string (default: "CaixinChannelLink")
  • id string nullable
  • url string required
  • published_at integer nullable
  • summary string nullable
  • channel_id string nullable
  • channel_name string nullable
  • channel_url string nullable
  • section string nullable
  • section_url string nullable
  • category_ids array (default: [])
  • tags array (default: [])
    • @type string (default: "CaixinTag")
    • id string nullable
    • name string required
  • video_url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No Caixin channel or no articles in it Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.