/toutiao/search

POST /api/toutiao/search

Price: 20 credits

Search Toutiao (toutiao.com) articles by keyword

How to use it

Search Toutiao by keyword and get article results, paged until count or the end of the results. Pick tab 'articles' for the news list, 'all' for the articles on the mixed results page. Pass a result id to toutiao/articles for the full article.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "刘翔"; minLength: 1)
• tab string required — Result tab: 'all' is the mixed results page, 'articles' the news tab (one of: "all", "articles")
• count integer required — Max number of results (min: 1; max: 100)

Response

• @type string (default: "ToutiaoSearchResult")
• id string required
• item_id string nullable
• url string required
• abstract string nullable
• source string nullable
• author_id string nullable
• author_name string nullable
• author_image string nullable
• image string nullable
• images array (default: [])
• image_count integer nullable
• categories array (default: [])
• has_video boolean nullable
• published_at integer nullable
• comment_count integer nullable
• like_count integer nullable
• read_count integer nullable
• favorite_count integer nullable
• forward_count integer nullable
• rank 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.