{ "openapi": "3.0.1", "info": { "title": "ZipRecruiter Job Real-Time Data", "description": "Collect ZipRecruiter job listings at scale — keyword search, salary & remote filters, company jobs & URL import. Structured JSON streams in real time for recruiters, job boards, market research, salary intel & AI workflows. Fast, lightweight runs. Up to 1,000 jobs per keyword. Webhook ready.", "version": "0.0", "x-build-id": "e2xEDR76MpO7UVOhP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~ziprecruiter-job-real-time-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-ziprecruiter-job-real-time-data", "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/b2b_leads~ziprecruiter-job-real-time-data/runs": { "post": { "operationId": "runs-sync-b2b_leads-ziprecruiter-job-real-time-data", "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/b2b_leads~ziprecruiter-job-real-time-data/run-sync": { "post": { "operationId": "run-sync-b2b_leads-ziprecruiter-job-real-time-data", "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": { "jobKeywords": { "title": "Job keywords", "type": "array", "description": "Main search terms — same as the ZipRecruiter search box. Each keyword runs as a separate paginated search (up to 1,000 jobs each).", "default": [ "software engineer" ], "items": { "type": "string" } }, "jobTitle": { "title": "Job title", "type": "string", "description": "Optional title filter combined with keywords (e.g. \"Senior Software Engineer\"). Leave empty to use keywords only.", "default": "" }, "jobCompany": { "title": "Company", "type": "string", "description": "Filter to a specific employer (e.g. \"Amazon\", \"Capital One\").", "default": "" }, "jobSkills": { "title": "Skills", "type": "array", "description": "Technologies or skills to narrow results (e.g. \"Python\", \"AWS\", \"React\").", "default": [], "items": { "type": "string" } }, "jobLocation": { "title": "Location", "type": "string", "description": "City, state, or country to search in (e.g. \"New York, NY\", \"Texas\", \"United States\"). Use \"United States\" for nationwide.", "default": "New York, NY" }, "radiusMiles": { "title": "Search radius (miles)", "minimum": 0, "maximum": 500, "type": "integer", "description": "Distance around the location center. Set to 0 to search the full location without a radius cap.", "default": 25 }, "jobExperienceLevels": { "title": "Experience levels", "type": "array", "description": "Seniority filter sent to ZipRecruiter (internship → executive). Leave all selected for no seniority filter.", "items": { "type": "string", "enum": [ "internship", "entry", "associate", "mid_senior", "director", "executive" ], "enumTitles": [ "Internship", "Entry level", "Associate", "Mid-Senior", "Director", "Executive" ] }, "default": [ "internship", "entry", "associate", "mid_senior", "director", "executive" ] }, "jobTypes": { "title": "Employment type", "type": "array", "description": "Full-time, contract, internship, etc. Leave all selected for any employment type.", "items": { "type": "string", "enum": [ "full_time", "part_time", "contract", "temporary", "internship" ], "enumTitles": [ "Full-time", "Part-time", "Contract", "Temporary", "Internship" ] }, "default": [ "full_time", "part_time", "contract", "temporary", "internship" ] }, "jobRemote": { "title": "Workplace type", "type": "array", "description": "On-site, remote, or hybrid. Leave all three selected for any workplace arrangement.", "items": { "type": "string", "enum": [ "onsite", "remote", "hybrid" ], "enumTitles": [ "On-site", "Remote", "Hybrid" ] }, "default": [ "onsite", "remote", "hybrid" ] }, "jobDatePosted": { "title": "Date posted", "enum": [ "any", "month", "week", "3days", "day" ], "type": "string", "description": "Only jobs posted within this window. When filtering by date, the shortest window is the past 24 hours.", "default": "any" }, "jobsPerQuery": { "title": "Jobs per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many unique jobs to collect per keyword (1–1,000). Pagination continues automatically until this target is reached.", "default": 25 }, "salaryMin": { "title": "Minimum salary (USD/year)", "minimum": 0, "maximum": 500000, "type": "integer", "description": "Annual pay floor. Jobs below this range are excluded. Leave empty for no minimum." }, "salaryMax": { "title": "Maximum salary (USD/year)", "minimum": 0, "maximum": 500000, "type": "integer", "description": "Annual pay ceiling. Jobs above this range are excluded. Leave empty for no maximum." }, "industryFilter": { "title": "Industry contains", "type": "string", "description": "Keep jobs whose industry field contains this text (e.g. \"Technology\", \"Healthcare\"). Case-insensitive partial match.", "default": "" }, "educationLevels": { "title": "Education levels", "type": "array", "description": "Keep jobs whose title or snippet mentions these education requirements. Leave empty for any education level.", "items": { "type": "string", "enum": [ "high_school", "associate", "bachelor", "master", "doctorate" ], "enumTitles": [ "High school", "Associate degree", "Bachelor's degree", "Master's degree", "Doctorate" ] }, "default": [] }, "easyApply": { "title": "ZipApply only", "type": "boolean", "description": "Only keep jobs with ZipRecruiter one-click apply (ZipApply).", "default": false }, "externalApplyOnly": { "title": "External apply only", "type": "boolean", "description": "Only keep jobs that redirect to the employer's career site (exclude ZipApply listings).", "default": false }, "excludeListingKeys": { "title": "Exclude listing keys", "type": "array", "description": "Skip known listing IDs from previous runs. Useful for incremental daily scrapes without duplicates.", "default": [], "items": { "type": "string" } }, "enableCompanyJobs": { "title": "Company jobs", "type": "boolean", "description": "Also search open roles at specific employers. Runs in parallel with keyword search.", "default": false }, "companyNames": { "title": "Company names", "type": "array", "description": "Employer names exactly as listed on ZipRecruiter (e.g. \"Amazon\", \"FedEx\", \"Capital One\").", "default": [], "items": { "type": "string" } }, "jobsPerCompany": { "title": "Jobs per company", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum unique jobs to collect per company name (1–1,000).", "default": 25 }, "enableScrapeByUrl": { "title": "Import from URL", "type": "boolean", "description": "Look up individual jobs by ZipRecruiter URL or listing key. Runs in addition to keyword and company search.", "default": false }, "scrapeUrls": { "title": "Job URLs or listing keys", "type": "array", "description": "ZipRecruiter job-redirect URLs, /jobs/j?lvk= links, or raw listing key strings.", "default": [], "items": { "type": "string" } }, "fetchJobDetails": { "title": "Include listing card details", "type": "boolean", "description": "Attach salary, benefits, job type, workplace, and apply URL on every row. Full HTML job descriptions are not included — use listing card data for fast, structured output.", "default": true }, "includeRaw": { "title": "Include extended source data", "type": "boolean", "description": "Attach the original source payload under the raw field. Useful for custom processing; increases dataset size.", "default": false }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional real-time push destination. Each new job row is POSTed here (Zapier, Make, Slack incoming webhook, CRM, Google Sheets).", "default": "" }, "webhookFormat": { "title": "Webhook format", "enum": [ "json", "slack" ], "type": "string", "description": "How each record is formatted for the webhook POST body.", "default": "json" }, "country": { "title": "Country market", "enum": [ "us", "ca", "uk" ], "type": "string", "description": "Routes ZipRecruiter searches to the correct country market. United States and Canada are fully supported.", "default": "us" }, "maxItems": { "title": "Max total items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on total job rows across all modes (keyword search + company jobs + URL import).", "default": 10000 }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "Residential proxy in the target country is strongly recommended for reliable, high-volume runs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }