/theverge/categories/search

POST /api/theverge/categories/search

Price: 20 credits

List the whole The Verge topic catalogue — every section, vertical, company, product and review category the site files stories under — with its slug, display title, archive URL and parent topic. The slugs returned here are the values accepted by theverge/categories/articles.

How to use it

Browse The Verge topic catalogue. The Verge keeps sections and topics in one namespace, so this returns both the broad sections (Tech, AI, Policy, Reviews, Entertainment, Science) and the narrow topics (OpenAI, iPhone, Headphone Reviews). Set count for how many to return, keyword to match a title or slug, parent to list the children of one topic, and top_level_only=true for the topics with no parent. Feed alias into theverge/categories/articles to read a topic's stories.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Only topics whose title or slug contains this text (examples: "apple")
• parent string nullable — Only topics nested directly under this parent topic slug (examples: "reviews")
• top_level_only boolean nullable — Restrict to topics that have no parent topic
• count integer required — Max number of topics to return (min: 1)

Response

• @type string (default: "ThevergeCatalogueCategory")
• id integer nullable
• node_id string required
• name string required
• alias string nullable
• path string nullable
• web_url string nullable
• parent_node_id string nullable
• parent_name string nullable
• parent_alias 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.