/smartnews/channels

POST /api/smartnews/channels

Price: 10 credits

List the SmartNews+ channels with their name, headline, image and the articles each currently features.

How to use it

Pass a channel id to smartnews/channels/articles for every article in the channel.

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 channels to return (min: 1)

Response

• @type string (default: "SmartnewsChannel")
• id string required
• url string required
• name string required
• identifier string nullable
• block_identifier string nullable
• headline string nullable
• layout string nullable
• image string nullable
• articles array (default: [])
  • @type string (default: "SmartnewsArticleCard")
  • id string required
  • url string nullable
  • short_title string nullable
  • source_url string nullable
  • publisher string nullable
  • publisher_id string nullable
  • publisher_logo string nullable
  • publisher_wide_logo string nullable
  • author string nullable
  • published_at integer nullable
  • discovered_at integer nullable
  • kind string nullable
  • is_premium boolean nullable
  • is_explainer boolean nullable
  • plus_url string nullable
  • channel_identifier string nullable
  • language string nullable
  • image string nullable
  • topics array (default: [])
    • @type string (default: "SmartnewsTopic")
    • id string required
    • name string nullable
    • display_name string nullable
    • kind string nullable
    • subject_type string nullable
    • image string nullable
  • is_featured boolean nullable
  • video object nullable
    • @type string (default: "SmartnewsVideo")
    • id string required
    • url string nullable
    • description string nullable
    • duration integer nullable
    • view_count integer nullable
    • like_count integer nullable
    • comment_count integer nullable
    • published_at integer nullable
    • updated_at integer nullable
    • channel_name string nullable
    • channel_image string nullable
    • image string nullable
    • video_type string nullable
    • video_key string nullable
    • language 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.