/krx/companies

POST /api/krx/companies

Price: 1 credit

Get a Korea Exchange listed company from KRX KIND by ticker: Korean and English name, ISIN, market and listing status, founding and listing dates, CEO, capital, employees, fiscal year end, contacts, industry, main products, name history and the latest summary financials in thousand won

How to use it

Tickers and company ids come from krx/companies/search and the company field of the other krx lists.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — KRX ticker or KIND company id (examples: "005930", "266690", "00593")

Response

• @type string (default: "KrxCompany")
• id string required
• name string required
• name_en string nullable
• isin string nullable
• ticker string nullable
• market string nullable
• listing_status string nullable
• founded_at integer nullable
• listed_at integer nullable
• ceo string nullable
• capital number nullable
• capital_currency string nullable
• capital_krw number nullable
• employees integer nullable
• fiscal_year_end_month integer nullable
• phone string nullable
• industry string nullable
• products string nullable
• address string nullable
• website string nullable
• name_history array (default: [])
  • @type string (default: "KrxNameChange")
  • changed_at integer nullable
  • name_before string nullable
  • name_after string nullable
• financials array (default: [])
  • @type string (default: "KrxFinancialItem")
  • statement string nullable
  • item string required
  • period string nullable
  • accounting_standard string nullable
  • value_krw_thousands number nullable

Errors

• 422 — id is not a KRX ticker or KIND company id 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 KIND 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.