# /jobstreet/salaries

`POST /api/jobstreet/salaries`

Price: 1 credit

Get the salary benchmark for a role on Jobstreet/JobsDB (SEEK South-East Asia) career insights across MY, SG, ID, PH, TH and HK markets: typical (median) pay, the lower and upper salary band, a suggested range, and the location the figure applies to. Narrow the figure to a city or region with location_id, or pick the pay basis with salary_type.

## How to use it

Fetch the salary benchmark for a role by alias or title (e.g. software-engineer or 'Data Analyst'). Set country to pick the market (MY/SG/ID/PH on jobstreet.com, TH/HK on jobsdb.com) which drives the currency; set location_id to a SEEK location id to narrow to a city or region (omit for the country-level figure); set salary_type to monthly, annual or hourly (South-East Asia pay is reported monthly, so annual/hourly may have no data). Returns one item with role_id, role_title, location_id, location_name, salary_median (typical pay), salary_min and salary_max (the band), suggested_min and suggested_max (a suggested range) and in_months.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `role` (string, required) — Role alias or title, e.g. software-engineer (examples: "software-engineer", "Data Analyst"; minLength: 1)
- `location_id` (integer, nullable) — Location id to narrow the salary to a city or region; omit for the country-level figure
- `salary_type` (string, nullable) — Salary basis (one of: "monthly", "annual", "hourly")
- `country` (string) — Market: MY/SG/ID/PH on jobstreet.com, TH/HK on jobsdb.com (drives locale and currency) (default: "MY"; one of: "MY", "SG", "ID", "PH", "TH", "HK")

## Response

### 200 — Successful Response

- `@type` (string) (default: "JobstreetSalary")
- `role_id` (string, nullable)
- `role_title` (string, nullable)
- `country` (string, nullable)
- `location_id` (integer, nullable)
- `location_name` (string, nullable)
- `salary_median` (number, nullable)
- `salary_min` (number, nullable)
- `salary_max` (number, nullable)
- `suggested_min` (number, nullable)
- `suggested_max` (number, nullable)
- `in_months` (integer, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

Salary benchmark not found for the given role

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.