/prtimes/releases

POST /api/prtimes/releases

Price: 5 credits

Get one PR TIMES press release: title, subtitle, issuing company, publication and update time, release type, full body as text and HTML, images, PDF attachment and reference-material links, keywords, business categories, locations and like count.

How to use it

A release id is the release number and the company number joined by a dot, as in the release URL. Find releases with prtimes/releases/search or prtimes/releases/latest. A release PR TIMES restricts to registered media comes back with only its ids, URL, publication time and is_media_only true.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• release string required — Release id or URL (examples: "6528.32953", "https://prtimes.jp/main/html/rd/p/000006528.000032953.html"; minLength: 1)

Response

• @type string (default: "PrtimesRelease")
• id string required
• release_id string required
• company_id string required
• url string required
• subtitle string nullable
• company_name string nullable
• published_at integer nullable
• updated_at integer nullable
• release_type_id string nullable
• release_type string nullable
• reference_url string nullable
• image string nullable
• attachment_url string nullable
• reference_attachment_url string nullable
• images array (default: [])
• keywords array (default: [])
• business_categories array (default: [])
  • @type string (default: "PrtimesBusinessCategory")
  • id string required
  • name string nullable
  • subcategory_id string nullable
  • subcategory_name string nullable
  • is_main boolean nullable
• locations array (default: [])
  • @type string (default: "PrtimesLocation")
  • prefecture_id string nullable
  • prefecture string nullable
  • city_id string nullable
  • city string nullable
  • location_type_id string nullable
  • location_type string nullable
• has_media_only_info boolean nullable
• is_media_only boolean nullable
• has_download_link boolean nullable
• like_count integer nullable
• text string nullable
• html 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 — No release under that release and company id 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.