/notebookcheck/articles/search

POST /api/notebookcheck/articles/search

Price: 20 credits

Search Notebookcheck news, reviews and editorial articles by title, kind, subtype and topic tag

How to use it

Results come back newest first, so a bare call with a small `count` is the way to ask what the site published most recently. `title_query` is a headline search that occasionally returns an article whose headline does not contain the phrase, so express a topic through `tags` instead. Several `tags` combine with AND unless `match_any_tag` is set. Feed `id` to notebookcheck/articles for the body text.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• title_query string nullable — Free text matched against the article title (examples: "Nvidia"; minLength: 1)
• article_types array nullable — Keep only these kinds of article (one of: "other", "review", "article", "news", "column", "cpu", "gpu", "magazine")
• exclude_article_types boolean — Drop the kinds named in `article_types` instead of keeping them (default: false)
• subtypes array nullable — Editorial subtype, lower case with underscores, as listed in service/parsers/notebookcheck/articles/catalogues.py (examples: ["flagship_review"], ["deal_news"])
• tags array nullable — Topic tag, lower case with underscores, as listed in service/parsers/notebookcheck/articles/catalogues.py (examples: ["ai"], ["gaming","amd"])
• match_any_tag boolean — Keep articles carrying any of `tags` rather than all of them (default: false)
• exclude_tags boolean — Drop the tags named in `tags` instead of keeping them (default: false)
• ticker_only boolean — Keep only breaking-news ticker items (default: false)
• count integer required — Max number of results (min: 1; max: 2000)

Response

• @type string (default: "NotebookcheckArticleListing")
• id string required
• url string required
• article_title string required
• article_type string nullable
• abstract string nullable
• author string nullable
• published_at integer nullable
• rating number nullable
• image 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 — 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.