{
"openapi": "3.0.1",
"info": {
"title": "Salary Benchmark - US Pay Percentiles for Any Role",
"description": "Benchmark any role's pay in a US city or state: annual salary percentiles (p10-p90), the sample size behind them, and where your proposed range sits. Hourly pay is annualized, mislabelled salaries corrected. From live job postings; billed per query.",
"version": "1.0",
"x-build-id": "uCyhESBIvKXp2ksri"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/hirebase~salary-benchmark/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-hirebase-salary-benchmark",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/hirebase~salary-benchmark/runs": {
"post": {
"operationId": "runs-sync-hirebase-salary-benchmark",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/hirebase~salary-benchmark/run-sync": {
"post": {
"operationId": "run-sync-hirebase-salary-benchmark",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"jobTitle": {
"title": "Job title",
"type": "string",
"description": "The role to benchmark, e.g. Registered Nurse or Senior Software Engineer. Hirebase widens it with comparable titles in the same pay band."
},
"similarTitles": {
"title": "Similar titles",
"type": "array",
"description": "Other titles for the same role, one per line, to widen the comparison (e.g. Backend Engineer).",
"items": {
"type": "string"
}
},
"jobPostingUrl": {
"title": "Or: job posting URL",
"type": "string",
"description": "A public job-posting URL to benchmark instead of a title - Hirebase reads the role from the posting. Takes precedence over the title."
},
"experienceLevels": {
"title": "Experience level",
"type": "array",
"description": "Seniority of the role.",
"items": {
"type": "string",
"enum": [
"Entry",
"Junior",
"Mid",
"Senior",
"Executive"
]
}
},
"yoeMin": {
"title": "Minimum years of experience",
"minimum": 0,
"maximum": 50,
"type": "integer",
"description": "Compare against postings asking for at least this many years."
},
"yoeMax": {
"title": "Maximum years of experience",
"minimum": 0,
"maximum": 50,
"type": "integer",
"description": "Compare against postings asking for at most this many years."
},
"locations": {
"title": "Locations",
"type": "array",
"description": "One per line, each benchmarked separately (one query each): City, State, Country, State, Country or Country - e.g. Austin, Texas, United States or London, England, United Kingdom. Pay is reported in that country's currency. Empty = the whole US.",
"items": {
"type": "string"
}
},
"locationTypes": {
"title": "Workplace type",
"type": "array",
"description": "Remote, hybrid, or in-person roles.",
"items": {
"type": "string",
"enum": [
"Remote",
"Hybrid",
"In-Person"
]
}
},
"industries": {
"title": "Industries",
"type": "array",
"description": "Company industry sectors.",
"items": {
"type": "string",
"enum": [
"Agriculture",
"Arts",
"Construction",
"Consumer Goods",
"Corporate Services",
"Design",
"Education",
"Energy & Mining",
"Entertainment",
"Finance",
"Healthcare",
"Legal",
"Manufacturing",
"Media & Communications",
"Nonprofit",
"Other",
"Public Administration",
"Public Safety",
"Real Estate",
"Recreation & Travel",
"Retail",
"Retail & Wholesale",
"Tech, Software & IT Services",
"Transportation & Logistics",
"Wellness & Fitness"
]
}
},
"subIndustries": {
"title": "Sub-industries",
"type": "array",
"description": "Narrower company sub-industry tags (e.g. Fintech).",
"items": {
"type": "string"
}
},
"postedWithinDays": {
"title": "Posted within (days)",
"minimum": 1,
"maximum": 365,
"type": "integer",
"description": "Compare against postings from the last N days (1-365). Default 90.",
"default": 90
},
"livePostingsOnly": {
"title": "Live postings only",
"type": "boolean",
"description": "Compare against postings that are still open. Off (default) also counts postings that closed within the window above - a bigger sample, and still what the market paid recently.",
"default": false
},
"proposedMin": {
"title": "Proposed range - minimum",
"minimum": 0,
"type": "integer",
"description": "Optional: the low end of a pay range you want to place in the market, in the period below and the location's currency."
},
"proposedMax": {
"title": "Proposed range - maximum",
"minimum": 0,
"type": "integer",
"description": "Optional: the high end of the range."
},
"proposedPeriod": {
"title": "Proposed range is per",
"enum": [
"yearly",
"monthly",
"daily",
"hourly"
],
"type": "string",
"description": "Hourly, daily and monthly figures are converted to annual (2,080 hours, 260 days, 12 months) before comparing.",
"default": "yearly"
},
"maxQueries": {
"title": "Max queries",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Safety cap on how many locations this run benchmarks (up to 10). You are charged per query, so this is also your spending cap.",
"default": 3
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}