{ "openapi": "3.0.1", "info": { "title": "ZipRecruiter Jobs Scraper - Salary, Company, Full Details", "description": "ZipRecruiter job search: title, company, pay with its source (employer, parsed or estimate), employment type, remote/hybrid, benefits, 1-click apply, reposts. Every site filter, past the ~800-job limit, monitor mode. Full description + employer profile add-on. US, Canada, UK, IE, DE, FR, IN, AU", "version": "0.1", "x-build-id": "faj7RREfFh56VnmG0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~ziprecruiter-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-ziprecruiter-jobs-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/scrapersdelight~ziprecruiter-jobs-scraper/runs": { "post": { "operationId": "runs-sync-scrapersdelight-ziprecruiter-jobs-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/scrapersdelight~ziprecruiter-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-ziprecruiter-jobs-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": "Job titles or keywords", "type": "array", "description": "One search per entry, e.g. \"registered nurse\" or \"warehouse associate\". Each is run in every location below. Leave empty with a location set to get every job there.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "City and state (\"Austin, TX\"), a ZIP code, a state (\"Texas\") or \"United States\". Canadian places work too (\"Toronto, ON\"). Empty = the whole country. On the country boards (see Country) use that country's towns.", "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "us", "uk", "ie", "de", "fr", "in", "au" ], "type": "string", "description": "us = ziprecruiter.com (United States and Canada, every filter below). The others are ZipRecruiter's separate country boards: they list title, company, place, date and a snippet, with full details as the add-on, and offer no pay / employment / experience filters.", "default": "us" }, "startUrls": { "title": "ZipRecruiter URLs", "type": "array", "description": "Optional. Paste search URLs (ziprecruiter.com/jobs-search?search=...&location=..., with their filters), listing pages (/Jobs/Registered-Nurse/-in-Austin,TX), company pages (/co//Jobs), job pages (/c//Job/...?jid=...), or country-board searches and jobs (ziprecruiter.co.uk/jobs/search?q=..., /jobs/).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "companyName": { "title": "Company", "type": "string", "description": "Only jobs from this employer, e.g. \"CVS Health\". On ziprecruiter.com the name is matched to ZipRecruiter's company record and searched with its company filter; otherwise jobs whose company name contains it are kept." }, "radius": { "title": "Distance from the location (miles)", "enum": [ "", "5", "10", "25", "50", "100", "any" ], "type": "string", "description": "How far from each location to search. Empty = ZipRecruiter's default (25 miles). On the country boards it is sent as the nearest kilometre option.", "default": "" }, "postedWithin": { "title": "Posted within", "enum": [ "any", "1", "3", "5", "7", "10", "14", "30" ], "type": "string", "description": "Only jobs posted (or reposted) in the last N days.", "default": "any" }, "postedWithinHours": { "title": "Posted within (hours)", "minimum": 0, "maximum": 2160, "type": "integer", "description": "Any window in hours, e.g. 6 for jobs posted in the last 6 hours. Overrides \"Posted within\" when set. 0 = off.", "default": 0 }, "employmentTypes": { "title": "Employment type", "type": "array", "description": "Keep jobs of any of these types (ziprecruiter.com).", "items": { "type": "string", "enum": [ "full_time", "part_time", "contract", "contract_to_hire", "temporary", "per_diem", "internship", "other" ], "enumTitles": [ "Full-time", "Part-time", "Contract", "Contract to hire", "Temporary", "Per diem", "Internship", "Other" ] }, "default": [] }, "experienceLevels": { "title": "Experience level", "type": "array", "description": "ZipRecruiter's experience-level filter (ziprecruiter.com).", "items": { "type": "string", "enum": [ "no_experience", "junior", "mid", "senior" ], "enumTitles": [ "No experience", "Junior", "Mid level", "Senior" ] }, "default": [] }, "workplaceTypes": { "title": "Workplace", "type": "array", "description": "On-site, remote or hybrid jobs (ziprecruiter.com). Remote also returns \"remote optional\" jobs, as on the site.", "items": { "type": "string", "enum": [ "on_site", "remote", "hybrid" ], "enumTitles": [ "On-site", "Remote", "Hybrid" ] }, "default": [] }, "applyType": { "title": "How to apply", "enum": [ "any", "quick_apply", "external" ], "type": "string", "description": "1-click apply = jobs you apply to on ZipRecruiter (ZipApply); employer site = jobs that send you to the employer's own page.", "default": "any" }, "salaryMin": { "title": "Minimum annual pay", "minimum": 0, "type": "integer", "description": "ZipRecruiter's own pay filter, as yearly pay (e.g. 60000). Jobs without pay are not returned when it is set. 0 = off.", "default": 0 }, "salaryMax": { "title": "Maximum annual pay", "minimum": 0, "type": "integer", "description": "Upper bound of the yearly pay, e.g. 90000. 0 = off.", "default": 0 }, "salarySource": { "title": "Pay shown", "enum": [ "any", "shown", "employer" ], "type": "string", "description": "Keep only jobs that show pay, or only jobs whose pay the employer published (drops figures ZipRecruiter parsed from the text or estimated).", "default": "any" }, "includeKeywords": { "title": "Must contain (any of)", "type": "array", "description": "Keep a job only when its title, company or summary contains at least one of these words (case-insensitive).", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Must not contain", "type": "array", "description": "Drop a job when its title or summary contains any of these words, e.g. \"travel\", \"per diem\".", "default": [], "items": { "type": "string" } }, "excludeCompanies": { "title": "Exclude companies", "type": "array", "description": "Drop jobs whose company name contains any of these (e.g. staffing agencies).", "default": [], "items": { "type": "string" } }, "skipReposts": { "title": "Skip reposted jobs", "type": "boolean", "description": "Drop jobs ZipRecruiter shows as reposted (first posted earlier than their current post date).", "default": false }, "includeDetails": { "title": "Full job details (add-on)", "type": "boolean", "description": "Fetch each job's full description plus education and experience requirements and the employer's profile (website, industry, size, HQ, founded, social links, Breakroom rating). One extra request per job; charged per job that gets a description.", "default": false }, "descriptionFormat": { "title": "Description format", "enum": [ "text", "html", "markdown", "all" ], "type": "string", "description": "Plain text, the original HTML, Markdown, or all three (with details).", "default": "text" }, "descriptionMaxLength": { "title": "Description length limit", "minimum": 0, "type": "integer", "description": "Cut descriptions to this many characters. 0 = full length.", "default": 0 }, "extractContacts": { "title": "Emails, phones and links from the description", "type": "boolean", "description": "Copy the email addresses, phone numbers and links the employer wrote in the job description into emails / phones / urls. Turns on full details (and its charge).", "default": false }, "deepSearch": { "title": "Deep search (past ZipRecruiter's ~800-job limit)", "type": "boolean", "description": "ZipRecruiter shows at most ~800 jobs per search. When a search hits that limit, it is re-run split by employment type, experience level and workplace, and the results are merged without duplicates.", "default": false }, "maxItems": { "title": "Maximum jobs", "minimum": 1, "type": "integer", "description": "Stop after this many jobs in total. You pay only for jobs delivered.", "default": 100 }, "maxItemsPerSearch": { "title": "Maximum jobs per search", "minimum": 0, "type": "integer", "description": "Cap for each query + location (or URL). 0 = no per-search cap.", "default": 0 }, "monitorMode": { "title": "Only new jobs (monitor)", "type": "boolean", "description": "Remember the jobs delivered by earlier runs with the same search settings and deliver only jobs not seen before. Schedule the actor to get a feed of new postings.", "default": false }, "monitorStoreName": { "title": "Monitor memory name", "type": "string", "description": "Named key-value store that keeps the monitor memory. Use different names to keep separate feeds.", "default": "ziprecruiter-jobs-monitor" }, "compact": { "title": "Compact rows", "type": "boolean", "description": "Only the core fields: id, title, company, location, workplace, employment type, pay, date, apply type, links (plus the description when details are on).", "default": false }, "useUnblocker": { "title": "Use Apify's Unblocker as the last resort", "type": "boolean", "description": "When ZipRecruiter refuses every other route, load its search pages through Apify's Unblocker (slower, under a per-run budget). Turn off to stop at the residential proxy.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. By default requests go out directly and switch to Apify's residential proxy (under a per-run budget) only when ZipRecruiter refuses them. Set your own proxy URLs or a proxy group to use them first.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }