/arstechnica/categories/search

POST /api/arstechnica/categories/search

Price: 1 credit

List Ars Technica sections, topic tags, long-form feature series or editorial article series with their slug, human-readable name, description, article count and archive URL. Order the catalogue by article count to reach the topics the newsroom actually writes about, or by name, slug or id. The slugs returned here are the values accepted by the categories, tags, feature_series and series filters of arstechnica/articles/search.

How to use it

Browse the Ars Technica taxonomy catalogue. taxonomy=categories returns the site sections (AI, Apple, Biz & IT, Cars, Gaming, Policy, Science, Security, Space, Tech...), taxonomy=tags the topic tag catalogue (tens of thousands of company, product and subject tags), taxonomy=feature-series the long-form feature collections and taxonomy=ars_series the multi-part editorial series. Set count for how many terms to return, keyword to match a name and hide_empty=true to drop unused terms. sort accepts article_count, name, alias, id or description and order accepts asc or desc: the tag catalogue holds tens of thousands of entries and the source lists it alphabetically, so sort=article_count with order=desc is how the busiest topics are reached. Feed alias into the categories/tags/feature_series/series filters of arstechnica/articles/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• taxonomy string — Which collection to list: site sections, topic tags, long-form feature series or editorial article series (default: "categories"; one of: "categories", "tags", "feature-series", "ars_series")
• keyword string nullable — Only terms whose name matches this text
• hide_empty boolean nullable — Drop terms that have no published articles
• sort string nullable — Field the terms are ordered by; the source orders by name when this is not set (one of: "name", "alias", "id", "article_count", "description")
• order string nullable — Sort direction; the source sorts ascending when this is not set (one of: "asc", "desc")
• count integer required — Max number of terms to return (min: 1)

Response

• @type string (default: "ArstechnicaTerm")
• id integer required
• name string required
• alias string nullable
• taxonomy string nullable
• web_url string nullable
• description string nullable
• article_count 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.