/bayt/salaries/search

POST /api/bayt/salaries/search

Price: 20 credits

Search Bayt.com salary estimates by job title or role across any supported MENA country site. Matches the query against Bayt's salary catalog (specific job titles and broad job-role categories) and returns the monthly salary distribution for each match: estimated minimum, maximum and median pay, currency, and the country the figures apply to.

How to use it

Look up salary estimates on Bayt.com by job title or role (e.g. 'accountant', 'software engineer', 'banking'). Set country for the national site (UAE, Saudi Arabia, Qatar, ...), optional currency to convert figures (defaults to the country's local currency; USD is supported), and count for how many matching roles to return. Each item has kind (job_title or job_role), name, url, country, location, currency, period, and salary_min / salary_max / salary_median (monthly).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Job title or role to look up salaries for (minLength: 1)
• country string — Bayt country site to query (default: "UAE"; one of: "UAE", "Saudi Arabia", "Qatar", "Kuwait", "Oman", "Bahrain", "Egypt", "Jordan", "Lebanon", "Morocco", "Algeria", "Tunisia", "Libya", "Iraq", "Yemen", "India", "Pakistan", "International")
• language string — Content language (default: "en"; one of: "en", "ar")
• currency string nullable — Display currency for the returned figures; defaults to the country's local currency (one of: "AED", "SAR", "QAR", "KWD", "OMR", "BHD", "EGP", "JOD", "LBP", "MAD", "DZD", "TND", "LYD", "IQD", "YER", "INR", "PKR", "USD")
• count integer required — Max number of matching roles to return (min: 1)

Response

• @type string (default: "BaytSalary")
• kind string required
• name string nullable
• url string nullable
• country string required (one of: "UAE", "Saudi Arabia", "Qatar", "Kuwait", "Oman", "Bahrain", "Egypt", "Jordan", "Lebanon", "Morocco", "Algeria", "Tunisia", "Libya", "Iraq", "Yemen", "India", "Pakistan", "International")
• location string nullable
• currency string nullable
• period string nullable
• salary_min number nullable
• salary_max number nullable
• salary_median number nullable
• last_reviewed_at 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 salary data found for the given query and country 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.