/openwork/companies/salaries

POST /api/openwork/companies/salaries

Price: 10 credits

Get the salary data employees reported for one employer on OpenWork (openwork.jp): average annual salary, salary range, average age and respondent count, the industry average, average salary and range per job role, and the company's places in OpenWork's salary rankings.

How to use it

Salaries are annual, in yen. Individual salary reviews are openwork/companies/reviews with category=salary.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company id or URL (examples: "a0C1000000s1nIR", "https://www.openwork.jp/company_answer.php?m_id=a0C1000000s1nIR&q_no=2")

Response

• @type string (default: "OpenworkCompanySalaries")
• company_id string required
• company_url string required
• company_name string nullable
• average_salary number nullable
• salary_min number nullable
• salary_max number nullable
• salary_currency string nullable
• average_age number nullable
• salary_respondent_count integer nullable
• respondent_employment string nullable
• industry_name string nullable
• industry_average_salary number nullable
• role_salaries array (default: [])
  • @type string (default: "OpenworkRoleSalary")
  • role string required
  • respondent_count integer nullable
  • average_salary number nullable
  • salary_min number nullable
  • salary_max number nullable
• rankings array (default: [])
  • @type string (default: "OpenworkSalaryRanking")
  • kind string required
  • name string nullable
  • rank integer nullable
  • ranking_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 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.