/careerbuilder/salaries

POST /api/careerbuilder/salaries

Price: 1 credit

Get CareerBuilder salary estimate for a job title and optional location

How to use it

Get CareerBuilder salary estimates for a job title, nationally or narrowed to a location. Returns the currency and both yearly and hourly pay broken down into median, mean, and the 10th, 25th, 75th and 90th percentiles, plus whether the figures are national or location-specific. The job title and location are matched to the closest known entries; an unknown location falls back to national figures.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• job_title string required — Job title or role to look up salary data for (examples: "Software Engineer", "Registered Nurse"; minLength: 1)
• location string nullable — Location to narrow the salary estimate to, formatted as "City, ST" (examples: "Atlanta, GA", "Austin, TX")

Response

• @type string (default: "CareerbuilderSalary")
• location string nullable
• currency string nullable
• is_national boolean nullable
• url string nullable
• per_year object nullable
  • @type string (default: "CareerbuilderSalaryStat")
  • median number nullable
  • mean number nullable
  • percentile_10 number nullable
  • percentile_25 number nullable
  • percentile_75 number nullable
  • percentile_90 number nullable
• per_hour object nullable
  • @type string (default: "CareerbuilderSalaryStat")
  • median number nullable
  • mean number nullable
  • percentile_10 number nullable
  • percentile_25 number nullable
  • percentile_75 number nullable
  • percentile_90 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 job title 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.