/csdn/articles/search

POST /api/csdn/articles/search

Price: 10 credits

Search CSDN blog articles by text, optionally limited to the last week, month, quarter or year, to one author or to VIP articles: title, summary, author, categories, tags, and exact view, like, bookmark and comment counts

How to use it

Rows carry no body — pass a row's `url` to csdn/articles for it.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search text (examples: "python", "Spring Boot 事务"; minLength: 1)
• count integer required — Max number of articles to return (min: 1; max: 500)
• period string — Only articles published within this period before now (default: "any"; one of: "any", "week", "month", "quarter", "year")
• author string nullable — Only articles by this CSDN username or blog URL (examples: "zhulinniao")
• vip_only boolean — Only VIP articles (default: false)

Response

• @type string (default: "CsdnSearchArticle")
• id string required
• url string nullable
• description string nullable
• article_type string nullable
• is_vip_only boolean nullable
• view_count integer nullable
• like_count integer nullable
• bookmark_count integer nullable
• comment_count integer nullable
• images array (default: [])
• categories array (default: [])
• tags array (default: [])
• keywords array (default: [])
• author_alias string nullable
• author_name string nullable
• author_image string nullable
• author_url string nullable
• author_certification string nullable
• column_id string nullable
• column_title string nullable
• column_url string nullable
• column_image string nullable
• created_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.