{
"openapi": "3.0.1",
"info": {
"title": "ZipRecruiter Scraper - Jobs, Salaries & Employer Leads",
"description": "Scrape ZipRecruiter jobs by keyword and location: title, company, logo, city/state, on-site or remote, and pay as listed plus an annualised salary range. Optional full description, employment type, posted date and employer firmographics, plus deduplicated employer leads. No start fee.",
"version": "1.0",
"x-build-id": "WYbN3EnJaTRjs9kEV"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapesage~ziprecruiter-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapesage-ziprecruiter-scraper",
"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/scrapesage~ziprecruiter-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapesage-ziprecruiter-scraper",
"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/scrapesage~ziprecruiter-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapesage-ziprecruiter-scraper",
"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": {
"searchQueries": {
"title": "Search queries (job title or keyword)",
"type": "array",
"description": "Job titles or keywords to search, e.g. registered nurse, software engineer, truck driver. Each query is combined with every location below.",
"items": {
"type": "string"
}
},
"locations": {
"title": "Locations",
"type": "array",
"description": "Where to search — City, ST (Dallas, TX), a state, a ZIP code, or Remote. Each location is combined with every search query.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "Start URLs (optional)",
"type": "array",
"description": "Direct ZipRecruiter URLs — search result pages (https://www.ziprecruiter.com/jobs-search?search=...&location=...) or individual job pages. Used in addition to the searches above.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"maxJobs": {
"title": "Max jobs",
"minimum": 0,
"type": "integer",
"description": "Maximum number of jobs to scrape across all searches. Set 0 for no limit (bounded by the run's time budget and ZipRecruiter's pagination).",
"default": 100
},
"includeJobDetails": {
"title": "Fetch full job details",
"type": "boolean",
"description": "Open each job page to also extract the full job description, employment type, posted date, benefits and the hiring company's firmographics (company size, year founded, HQ location, website). Costs one extra page render per job. When off (default) you still get everything the result cards carry: title, company + company URL, logo, location, on-site/remote/hybrid, pay (raw and annualised) and the job URL.",
"default": false
},
"deduplicateEmployers": {
"title": "Emit employer leads",
"type": "boolean",
"description": "In addition to job records, output one deduplicated employer record per hiring company — open-job count, locations, sample titles, remote-role count, advertised salary range and a 0-100 leadScore. Turn on Fetch full job details as well to enrich each employer with company size, year founded, HQ and website. Active hiring is a strong B2B buying signal.",
"default": false
},
"remoteOnly": {
"title": "Remote jobs only",
"type": "boolean",
"description": "Only keep jobs ZipRecruiter flags as remote (work arrangement \"Remote\", or a remote-titled role).",
"default": false
},
"employmentType": {
"title": "Employment type",
"enum": [
"any",
"full_time",
"part_time",
"contract",
"temporary",
"internship"
],
"type": "string",
"description": "Keep only jobs of this employment type.",
"default": "any"
},
"salaryMin": {
"title": "Minimum annual salary",
"type": "integer",
"description": "Keep only jobs paying at least this much per year. Hourly, weekly and monthly pay is annualised before the comparison (e.g. $53.50/hr counts as ~$111,280/yr), so you will not lose hourly roles that clear the bar. Jobs with no advertised pay are excluded when this is set. Leave empty for no filter."
},
"monitorMode": {
"title": "Monitor mode (only new jobs)",
"type": "boolean",
"description": "Remember jobs seen in previous runs and only output listings that are new since last time. Ideal with a Schedule to track a role or market. State is kept in a named key-value store and does not interfere with the Apify scheduler.",
"default": false
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Proxies used for every request. Residential proxies are required — ZipRecruiter sits behind a Cloudflare managed challenge that datacenter IPs do not clear. The default (Apify residential, US) is the tested configuration.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
}
}
},
"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
}
}
},
"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
}
}
}
}
}
}
}
}
}
}