/caixin/articles/search

POST /api/caixin/articles/search

Price: 5 credits

Search Caixin (caixin.com) by keyword across news, magazines, data, blogs, videos, photos, topics and other sections, in the full text or titles only, within the last day, week, month or year, ordered by Caixin's ranking, newest or oldest first; each result has headline, summary, matching snippet, byline, channel, keywords, image, the photo set of a gallery, publication time and URL

How to use it

Pass a result 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 results to return (min: 1; max: 1000)
• keyword string required — Words to search for (examples: "银行", "新能源"; minLength: 1)
• tab string — Kind of content to search (default: "all"; one of: "all", "magazines", "data", "wenews", "mini", "blogs", "videos", "photos", "data_stories", "special_topics", "conferences", "special_features")
• search_in string — Where the keyword must appear (default: "full_text"; one of: "full_text", "headline")
• period string — How far back results may be published (default: "any"; one of: "any", "day", "week", "month", "year")
• sort string — Result order (default: "smart"; one of: "smart", "newest", "oldest")

Response

• @type string (default: "CaixinSearchArticle")
• id string required
• url string required
• summary string nullable
• snippet string nullable
• byline string nullable
• author string nullable
• publication string nullable
• section string nullable
• channel_id string nullable
• channel_name string nullable
• channel_url string nullable
• category_ids array (default: [])
• keywords array (default: [])
• image string nullable
• images array (default: [])
• magazine_id string nullable
• published_at integer nullable
• updated_at integer 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 — The entity was not found, or a precondition failed 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.