/axios/topics

POST /api/axios/topics

Price: 5 credits

List the whole Axios topic catalogue with the subtopics filed under each topic. Every topic and subtopic carries its identifier, slug, display name, page title, description, navigation position and whether it appears in the site navigation.

How to use it

List the Axios topic catalogue with its subtopics. count says how many topics to return. Each item has id, alias (the URL slug), name, page_title, description, icon, is_local, nav_position, show_in_nav and subtopics[] with the same fields plus topic_id and sponsor. Feed the id values into axios/topics/articles as topic_ids or subtopic_ids. Only the topics that head the site navigation carry nav_position, and only a minority of topics own subtopics — the rest come back with an empty subtopics[] and are still valid topic_ids. Three aliases — business, health and sports — each name two different topics, an Axios Local one and a national one told apart by is_local, so resolve a topic by id and never by alias.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of topics to return (min: 1)

Response

• @type string (default: "AxiosTopicDetail")
• id string required
• alias string required
• name string nullable
• page_title string nullable
• description string nullable
• is_local boolean nullable
• nav_position integer nullable
• show_in_nav boolean nullable
• icon string nullable
• subtopics array (default: [])
  • @type string (default: "AxiosSubtopic")
  • id string required
  • alias string required
  • name string nullable
  • page_title string nullable
  • description string nullable
  • social_title string nullable
  • topic_id string nullable
  • nav_position integer nullable
  • show_in_nav boolean nullable
  • sponsor 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.