/saramin/companies/salaries

POST /api/saramin/companies/salaries

Price: 10 credits

Get Saramin company salary statistics by id

How to use it

Get the salary statistics of a company on Saramin by its id. Returns the average, minimum and maximum annual salary (in units of 10,000 KRW / 만원) for the latest reported year, the year-over-year change, the company's salary rank within its industry, the data reliability level, how the salary compares to the industry average, the data source, and the per-year salary trend (company average, minimum, maximum and the industry average for each reported year).

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: "SaraminCompanySalaryStats")
• id string required
• name string required
• url string required
• year integer nullable
• average_salary number nullable
• min_salary number nullable
• max_salary number nullable
• yoy_change_percent number nullable
• yoy_increased boolean nullable
• industry_rank integer nullable
• industry_rank_category string nullable
• reliability string nullable
• vs_industry_percent number nullable
• vs_industry_higher boolean nullable
• source string nullable
• yearly_salaries array (default: [])
  • @type string (default: "SaraminSalaryYear")
  • year integer required
  • average_salary number nullable
  • min_salary number nullable
  • max_salary number nullable
  • industry_average_salary number 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 salary 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.