/itmedia/articles/search

POST /api/itmedia/articles/search

Price: 20 credits

Search ITmedia articles by keyword across its publications, newest first or by relevance; without a keyword it lists the latest articles. Each article carries title, subtitle, description, publication and update time, author, keywords, series, category, copyright, page count and the companies, people and places it names.

How to use it

A query returns at most 10,000 articles. aiplus and pcuser are listed by itmedia/archives and itmedia/rankings instead. Pass an article url to itmedia/articles for the full text.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Search words (examples: "半導体", "生成AI"; maxLength: 100)
• verticals array — ITmedia publications to search, all when empty (default: []; one of: "news", "aiplus", "pcuser", "mobile", "business", "enterprise", "smartjapan", "marketing", "atmarkit", "monoist", "eetimes", "edn", "built", "techtarget", "keymans", "techfactory", "executive"; examples: ["news"])
• sort string — Result order (default: "newest"; one of: "newest", "relevance")
• count integer required — Max number of articles to return (min: 1; max: 10000)

Response

• @type string (default: "ItmediaArticleCard")
• id string required
• url string required
• subtitle string nullable
• description string nullable
• published_at integer nullable
• updated_at integer nullable
• image string nullable
• site_name string nullable
• section string nullable
• article_number string nullable
• author string nullable
• writer_id string nullable
• writers array (default: [])
• keywords array (default: [])
• series string nullable
• series_id string nullable
• sponsor string nullable
• page_count integer nullable
• subscription_type string nullable
• word_count integer nullable
• character_count integer nullable
• companies array (default: [])
• people array (default: [])
• locations array (default: [])
• concepts array (default: [])
• classifications array (default: [])
• category string nullable
• category_id string nullable
• category_group string nullable
• category_group_id string nullable
• copyright string nullable
• intent string nullable
• topic string nullable
• forum string nullable
• department string nullable
• planning_department string nullable
• download_url string nullable
• topic_keywords array (default: [])
• events array (default: [])
• expires_at 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.