{ "openapi": "3.0.1", "info": { "title": "ZipRecruiter Job Search Results & Salary Scraper", "description": "Extract job postings from ZipRecruiter.com search results - title, company, location, parsed salary range, city, state, and apply URL. Search by keyword and location or supply your own filtered search URL.", "version": "1.0", "x-build-id": "MiuZfLBEFxbiXz4Uj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~ziprecruiter-job-search-results-and-salary-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-ziprecruiter-job-search-results-and-salary-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/vexaloom-labs~ziprecruiter-job-search-results-and-salary-scraper/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-ziprecruiter-job-search-results-and-salary-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/vexaloom-labs~ziprecruiter-job-search-results-and-salary-scraper/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-ziprecruiter-job-search-results-and-salary-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": { "mode": { "title": "What do you want to scrape?", "enum": [ "search", "byUrls", "salary" ], "type": "string", "description": "Search job postings, scrape URLs you already have, or get salary benchmarks for a role and location.", "default": "search" }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Job titles or keywords, e.g. `registered nurse` or `software engineer`. Every keyword is searched in every location below.", "items": { "type": "string" }, "default": [] }, "locations": { "title": "Locations", "type": "array", "description": "Cities, states, ZIP codes or `United States` for a nationwide search. Every keyword is searched in every location.", "items": { "type": "string" }, "default": [ "United States" ] }, "companyName": { "title": "Company name", "type": "string", "description": "Only jobs from this employer, e.g. `Visa`. Leave the keywords empty to browse every open role at the company.", "default": "" }, "startUrls": { "title": "ZipRecruiter URLs", "type": "array", "description": "Search, job, company or salary URLs. Use this with `Scrape specific URLs`; filters already in a search URL are kept.", "items": { "type": "string" }, "default": [] }, "jobType": { "title": "Job type", "enum": [ "any", "full_time", "part_time", "contract", "contract_to_hire", "temporary", "as_needed", "other", "internship" ], "type": "string", "description": "Employment-type filter for keyword searches.", "default": "any" }, "workplace": { "title": "Workplace type", "enum": [ "any", "remote", "hybrid", "onsite" ], "type": "string", "description": "Work arrangement for keyword searches.", "default": "any" }, "experienceLevels": { "title": "Experience levels", "type": "array", "description": "Restrict to one or more seniority levels. Empty means no filter.", "items": { "type": "string", "enum": [ "no_experience", "junior", "mid", "senior" ], "enumTitles": [ "No experience", "Junior", "Mid", "Senior" ] }, "default": [] }, "daysPosted": { "title": "Posted within (days)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Only jobs posted within the last N days. 0 means any time.", "default": 0 }, "radiusMiles": { "title": "Search radius (miles)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Distance around each location. 0 uses ZipRecruiter's default.", "default": 0 }, "salaryMin": { "title": "Minimum annual salary (USD)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Only jobs whose advertised annual pay reaches this amount. 0 means no lower bound.", "default": 0 }, "salaryMax": { "title": "Maximum annual salary (USD)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Only jobs whose advertised annual pay stays at or below this amount. Best effort; 0 means no upper bound.", "default": 0 }, "fetchDescriptions": { "title": "Fetch full descriptions", "type": "boolean", "description": "Fetch each posting's detail page for the complete description, benefits, company profile and apply details. Off gives faster card-only rows.", "default": true }, "includeCompanyProfile": { "title": "Include company profile", "type": "boolean", "description": "Add industry, website, size, headquarters, rating and about text from the posting's company data.", "default": true }, "maxItems": { "title": "Max records", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of job or salary records to return across all searches and URLs.", "default": 50 }, "maxSearches": { "title": "Max searches", "minimum": 1, "maximum": 100, "type": "integer", "description": "Cap on keyword × location combinations in search mode.", "default": 100 }, "salaryRoles": { "title": "Salary roles", "type": "array", "description": "Job titles for salary benchmarks, e.g. `registered nurse` or `data analyst`. Used in salary mode.", "items": { "type": "string" }, "default": [] }, "salaryLocations": { "title": "Salary locations", "type": "array", "description": "Cities, states or `United States` for salary benchmarks. Every role is looked up in every location.", "items": { "type": "string" }, "default": [ "United States" ] }, "salaryUrls": { "title": "Salary page URLs", "type": "array", "description": "Exact ZipRecruiter `/Salaries/...` URLs. When set, these are used instead of role and location pairs.", "items": { "type": "string" }, "default": [] } } }, "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 } } } } } } } } } }