/krx/disclosures/search

POST /api/krx/disclosures/search

Price: 5 credits

Search Korea Exchange (KRX KIND) disclosures, newest first, by filing window, company ticker, disclosure category, report title words, submitter and market: receipt number, title, filing time, company, market and submitter

How to use it

Pass a filing's id to krx/disclosures for its documents and text. A window longer than one year needs company, report_name or submitter, and no window can exceed three years.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• date_from integer nullable — Earliest filing day, unix seconds (UTC day); defaults to 30 days before date_to
• date_to integer nullable — Latest filing day, unix seconds (UTC day); defaults to today in Korea
• company string nullable — KRX ticker of the filing company (examples: "005930", "A266690")
• categories array nullable — Disclosure categories to keep (one of: "ad_hoc", "market_action", "fair_disclosure", "notices", "periodic", "special", "issuance", "ownership", "warrants", "proxy_voting", "fair_trade", "bond_ad_hoc", "bond_market_action", "etn")
• report_name string nullable — Words the report title contains (examples: "사업보고서", "자기주식")
• submitter string nullable — Submitter name (examples: "코스닥시장본부")
• market string — Market of the filing company (default: "all"; one of: "all", "kospi", "kosdaq", "konex", "bonds", "derivatives")
• count integer required — Max number of results (min: 1; max: 5000)

Response

• @type string (default: "KrxDisclosure")
• id string required
• url string required
• published_at integer nullable
• company_id string nullable
• company_name string nullable
• market string nullable
• badges array (default: [])
• submitter string nullable

Errors

• 422 — Invalid ticker or a date window KRX refuses 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.