{ "openapi": "3.0.1", "info": { "title": "ZipRecruiter Jobs Scraper — Remote Jobs, Salaries & Details", "description": "Extract ZipRecruiter jobs by keyword, location, or direct URL. Supports remote filters, salary and apply fields, detail enrichment, US residential proxy defaults, and in-run deduplication.", "version": "0.4", "x-build-id": "HaMZ6US9rS359UVms" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crowdpull~crowdpull-ziprecruiter-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crowdpull-crowdpull-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/crowdpull~crowdpull-ziprecruiter-jobs-scraper/runs": { "post": { "operationId": "runs-sync-crowdpull-crowdpull-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/crowdpull~crowdpull-ziprecruiter-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-crowdpull-crowdpull-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", "required": [ "proxyConfig" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional ZipRecruiter search result or job detail URLs. Search URL filters are preserved exactly, including radius, salary, employment type, and date filters.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL", "description": "ZipRecruiter search result or job detail URL." } } } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Job titles or keywords to search for.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Locations to search. Use USA for nationwide US results.", "items": { "type": "string" } }, "countryCodes": { "title": "Country Codes", "type": "array", "description": "ZipRecruiter country domains to search for generated keyword/location searches. Supported: US, CA, GB, IE, IN, DE, FR, NZ.", "items": { "type": "string" } }, "apiKey": { "title": "ZipRecruiter Search API Key", "type": "string", "description": "Optional. In auto mode, a key makes generated keyword/location searches use the ZipRecruiter Search API unless start URLs are supplied. Without a key, auto mode uses pure HTTP web search." }, "searchMode": { "title": "Search Mode", "enum": [ "auto", "api", "web", "fallbackUrls" ], "type": "string", "description": "Auto uses API when a key exists and no start URLs are supplied, otherwise HTTP web search. API requires a key. Web uses pure HTTP search parsing. Fallback URLs only emits manual search links.", "default": "auto" }, "maxItems": { "title": "Max Jobs", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Maximum number of job rows to emit. Set to 0 for unlimited within the query/page limits.", "default": 100 }, "jobsPerPage": { "title": "Jobs Per API Page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of jobs requested per ZipRecruiter API page.", "default": 25 }, "pagesPerSearch": { "title": "Pages Per Search", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of API pages to fetch for each query/location pair.", "default": 1 }, "radiusMiles": { "title": "Radius Miles", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Search radius in miles. Web mode uses ZipRecruiter's radius parameter, usually normalized to 25 miles minimum.", "default": 25 }, "daysAgo": { "title": "Posted Within Days", "minimum": 0, "maximum": 90, "type": "integer", "description": "Only return jobs posted within this many days. Web mode sends this as days; API mode sends this as days_ago. Set 0 for no date filter.", "default": 0 }, "employmentType": { "title": "Employment Type", "enum": [ "", "full_time", "part_time", "contract", "temporary", "internship" ], "type": "string", "description": "Filter web results by employment type.", "default": "" }, "locationType": { "title": "Location Type", "enum": [ "", "remote", "only_remote", "hybrid", "in_person", "remote_optional" ], "type": "string", "description": "Filter web results by remote/hybrid/on-site signal.", "default": "only_remote" }, "minAnnualSalary": { "title": "Minimum Annual Salary", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Filter web results by minimum annual salary when ZipRecruiter supports it for the query.", "default": 0 }, "maxAnnualSalary": { "title": "Maximum Annual Salary", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Filter web results by maximum annual salary ceiling when ZipRecruiter supports it for the query.", "default": 0 }, "applyType": { "title": "Apply Type", "enum": [ "", "one_click_apply" ], "type": "string", "description": "Filter web results by apply type. Currently maps quick_apply to ZipRecruiter's one_click_apply value.", "default": "" }, "experienceLevel": { "title": "Experience Level", "enum": [ "", "entry_level", "mid_level", "senior_level" ], "type": "string", "description": "Filter web results by seniority signal.", "default": "" }, "includeEmptyFilterParams": { "title": "Include Empty Filter Parameters", "type": "boolean", "description": "When true, generated web search URLs include empty refine_by_* parameters for filters left as Any, matching ZipRecruiter's browser URLs more closely.", "default": false }, "seniorityFiltersExplicitlySet": { "title": "Seniority Filters Explicitly Set", "type": "boolean", "description": "Adds seniority_filters_explicitly_set= to generated web search URLs.", "default": false }, "applyTypesExplicitlySet": { "title": "Apply Types Explicitly Set", "type": "boolean", "description": "Adds apply_types_explicitly_set= to generated web search URLs.", "default": false }, "employmentTypesExplicitlySet": { "title": "Employment Types Explicitly Set", "type": "boolean", "description": "Adds employment_types_explicitly_set= to generated web search URLs.", "default": false }, "locationTypesExplicitlySet": { "title": "Location Types Explicitly Set", "type": "boolean", "description": "Adds location_types_explicitly_set= to generated web search URLs.", "default": false }, "linkKey": { "title": "Link Key", "type": "string", "description": "Advanced passthrough for ZipRecruiter's lk query parameter. This is usually an opaque browser/session token copied from a URL." }, "extraSearchParams": { "title": "Extra Search Parameters", "type": "object", "description": "Advanced escape hatch for raw ZipRecruiter web query parameters discovered later. Empty string values are preserved." }, "includeJobDetails": { "title": "Fetch Job Details", "type": "boolean", "description": "When web mode is used, fetch each result URL and parse JobPosting JSON-LD for description, company, location, salary, and dates.", "default": true }, "fallbackToSearchUrls": { "title": "Generate Search URLs Without API Key", "type": "boolean", "description": "When true and API/web search does not return results, generate one search_url row per search. Rows are always saved to the FALLBACK_SEARCH_URLS key-value record.", "default": true }, "pushFallbackSearchUrls": { "title": "Push Fallback URLs to Dataset", "type": "boolean", "description": "When true, fallback search_url rows are also pushed to the default dataset. Turn off for pay-per-job pricing so fallback links are not counted as job results.", "default": true }, "deduplicate": { "title": "Deduplicate Results", "type": "boolean", "description": "Deduplicate jobs within a single run by URL, external ID, or title/company/location.", "default": true }, "incrementalMode": { "title": "Incremental Mode", "type": "boolean", "description": "When true, recurring runs emit only jobs that are new or whose tracked content changed after re-fetching them.", "default": false }, "incrementalStoreName": { "title": "Incremental Store Name", "type": "string", "description": "Named key-value store used for incremental state across runs.", "default": "ziprecruiter-incremental" }, "delayMs": { "title": "Delay Between HTTP Requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Polite delay between HTTP requests.", "default": 250 }, "proxyConfig": { "title": "Proxy Configuration", "type": "object", "description": "Required. ZipRecruiter blocks direct Apify datacenter egress in remote runs; US residential Apify Proxy is the default and recommended setting, especially for detail-page enrichment.", "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 } } } } } } } } } }