/saramin/companies/finances

POST /api/saramin/companies/finances

Price: 10 credits

Get Saramin company financial disclosures by id

How to use it

Get the financial disclosures of a company on Saramin by its id. Returns the company's major shareholders (up to five: name, common and preferred share percentages, relationship to the largest shareholder and to the company) with their data source, and the list of regulatory disclosure reports (title, date, source and document link).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Saramin company id (csn token), or a company URL containing it (examples: "aTArMW5EbXVaUFRYcTNNdVQ1VFdJQT09", "https://www.saramin.co.kr/zf_user/company-info/view?csn=aTArMW5EbXVaUFRYcTNNdVQ1VFdJQT09"; minLength: 1)

Response

• @type string (default: "SaraminCompanyFinances")
• id string required
• name string required
• url string required
• shareholders array (default: [])
  • @type string (default: "SaraminCompanyShareholder")
  • name string required
  • common_share_percent number nullable
  • preferred_share_percent number nullable
  • major_shareholder_relation string nullable
  • company_relation string nullable
• shareholders_source string nullable
• disclosures array (default: [])
  • @type string (default: "SaraminCompanyDisclosure")
  • date string nullable
  • source string nullable
  • url 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 financial data found for this company 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.