/displayspecifications/news

POST /api/displayspecifications/news

Price: 5 credits

Return one DisplaySpecifications news article: headline, publication timestamp, lead image, the body as plain text and as HTML, every inline image, the ids of the models the article links to and the related articles the source lists beside it.

How to use it

`linked_model_ids` are the catalogue entries the editors linked inside the body, which is how you go from an announcement to its full specification sheet. Articles are written in English only, unlike the specification pages, so there is no language to choose here. Ids are opaque hexadecimal — take them from the news feed endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• article string required — News article URL or the bare hexadecimal article id (examples: "fb691095", "https://www.displayspecifications.com/en/news/fb691095"; minLength: 1)

Response

• @type string (default: "DisplayspecificationsNewsArticle")
• id string required
• url string required
• locale string required
• headline string required
• published string nullable
• published_at integer nullable
• image string nullable
• text string required
• html string required
• images array (default: [])
• linked_model_ids array (default: [])
• related_news array (default: [])
  • @type string (default: "DisplayspecificationsRelatedNews")
  • id string required
  • url string required
  • headline string required

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 — No news article exists under this id on DisplaySpecifications. 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.