/prtimes/companies

POST /api/prtimes/companies

Price: 1 credit

Get one company on PR TIMES: name, description, industry, address, phone, representative, listing, capital, founding year and month, website and social links, logo image, follower count and the years it published releases in.

How to use it

Every release carries its company_id; prtimes/companies/releases lists the company's releases.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company id or URL (examples: "32953", "https://prtimes.jp/main/html/searchrlp/company_id/32953"; minLength: 1)

Response

• @type string (default: "PrtimesCompany")
• id string required
• url string required
• name string nullable
• description string nullable
• industry string nullable
• address string nullable
• address_line2 string nullable
• phone string nullable
• representative string nullable
• listing string nullable
• capital number nullable
• capital_text string nullable
• founded_year integer nullable
• founded_month integer nullable
• website string nullable
• twitter_url string nullable
• facebook_url string nullable
• youtube_url string nullable
• image string nullable
• cover string nullable
• follower_count integer nullable
• release_years array (default: [])
• has_press_kit boolean nullable
• press_kit_item_count integer nullable
• updated_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 — No company under that 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.