apyhub
ARTIFICIAL INTELLIGENCE · HR

Global Salary Benchmark API

What it does

Salary Range Estimator estimates a market salary band for a candidate from a job title, location, and resume content. Send those three inputs, and get back a market context string plus an estimated range with min, max, and currency.

Use it when you need to benchmark compensation during recruiting, pre-screening, or offer planning. The response is designed to be easy to plug into hiring workflows: one field explains the market context, and one structured object gives the salary range in a standard currency format.

Salary Range Estimator is useful for internal comp checks, recruiter tooling, and applicant-facing guidance where you want a fast estimate grounded in the role, location, and experience described in the resume. Keep in mind that the output is an estimate, not a contractual offer or payroll record.

POST
Estimate the market salary range for a candidate
http://localhost:8080/namastesumalya/estimate-market-salary-range
QUICKSTARTGUIDE

Quickstart

Estimate a market salary range for a job by sending the job title, location, and resume content in a JSON request body.

curl -X POST "http://localhost:8080/namastesumalya/estimate-market-salary-range" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "jobTitle": "Staff Software Engineer",
    "location": "New York, NY",
    "resumeContent": "Candidate experience and skills..."
  }'

What you'll get back

Returns a JSON object with two top-level fields: marketContext is a string describing the salary market context, and estimatedRange is an object containing min and max integers plus a currency string.

{
  "marketContext": "NYC Fintech salaries for Staff roles with HFT experience are at an all-time high.",
  "estimatedRange": {
    "min": 250000,
    "max": 450000,
    "currency": "USD"
  }
}
TRY ITLIVE · 750 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*

About this endpoint

What it does

Estimates a market salary range for a candidate from the provided job title, location, and resume content. The response returns a market context string and an estimated salary range object.

Request Body

ParameterTypeMandatoryDescription
jobTitleStringYesThe candidate’s job title.
locationStringYesThe candidate’s location.
resumeContentStringYesThe candidate’s resume or experience summary text.

Response

Returns a JSON object with a marketContext string field and an estimatedRange object field. estimatedRange contains min and max integer fields plus a currency string field.

ParameterTypeMandatoryDescription
marketContextStringNoA textual summary of the market factors used to estimate the range.
estimatedRangeObjectNoThe estimated salary range object containing min, max, and currency.
estimatedRange.minIntegerNoThe lower bound of the estimated salary range.
estimatedRange.maxIntegerNoThe upper bound of the estimated salary range.
estimatedRange.currencyStringNoThe currency code for the estimated range.

Body

Name
Type
Description
bodyREQUIRED
object
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.