/saramin/salaries/search

POST /api/saramin/salaries/search

Price: 10 credits

Search Saramin company salary data by company name

How to use it

Search Saramin (saramin.co.kr) salary data by company name. Returns a ranked list of companies with their reported salaries: company name, company token (csn), salary and profile URLs, logo image, company types, industry, the years with reported data, whether the company is currently hiring, and the average / minimum / maximum annual salary (in units of 10,000 KRW / 만원). Order results by popularity, average salary, maximum salary, sales, latest update or company name, and optionally restrict by salary range or to companies that are actively hiring.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Company name to search salary data for (examples: "삼성", "현대"; minLength: 1)
• count integer required — Max number of results (min: 1)
• sort string — Result ordering (default: "popular"; one of: "popular", "latest", "average_salary", "max_salary", "sales", "name")
• salary_min integer nullable — Minimum average annual salary in 10,000 KRW (만원) (min: 0)
• salary_max integer nullable — Maximum average annual salary in 10,000 KRW (만원) (min: 0)
• recruiting_only boolean — Only companies with active job postings (default: false)

Response

• @type string (default: "SaraminCompanySalary")
• name string nullable
• csn string nullable
• salary_url string nullable
• profile_url string nullable
• image string nullable
• company_types array (default: [])
• industry string nullable
• update_years array (default: [])
• is_recruiting boolean (default: false)
• average_salary number nullable
• min_salary number nullable
• max_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 name 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.