/opencomp/salaries

POST /api/opencomp/salaries

Price: 5 credits

Get the salary for a job title in a US metro or the US country average: 25th, 50th and 75th percentile total cash, cost-of-living index and adjusted total cash, median home price, the role's job type, family and area, and the other locations covered for the title

How to use it

Figures are annual total cash in USD for the level and company size the record names. opencomp/locations lists location aliases and opencomp/locations/titles lists the title aliases covered in one location; a title outside that list returns 412.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — Location alias (examples: "san-francisco-ca", "united-states"; minLength: 1)

Response

• @type string (default: "OpencompSalary")
• alias string required
• url string required
• title_alias string required
• location string nullable
• location_alias string required
• level string nullable
• company_size string nullable
• currency string (default: "USD")
• total_cash_p25 number nullable
• total_cash_median number nullable
• total_cash_p75 number nullable
• cost_of_living_index number nullable
• col_adjusted_total_cash number nullable
• median_home_price number nullable
• job_type string nullable
• job_family string nullable
• job_area string nullable
• responsibilities string nullable
• level_description string nullable
• quality_of_life array (default: [])
  • @type string (default: "OpencompQualitySection")
  • heading string nullable
  • text string nullable
  • points array (default: [])
    • @type string (default: "OpencompQualityPoint")
    • group string nullable
    • label string nullable
    • text string nullable
• other_locations array (default: [])
  • @type string (default: "OpencompLocationRef")
  • alias string required
  • name string required
  • url string required

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 — OpenComp has no salary page for this title in this location 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.