{ "openapi": "3.0.1", "info": { "title": "ZipRecruiter Jobs Scraper", "description": "Scrape ZipRecruiter job postings into clean structured data ā€” search by keyword + location or paste a filtered search URL. Fast overview (titles + links) or full detail: company, location, salary band, employment type, posted/expiry dates, category, industry & description. Clean JSON/CSV, no code.", "version": "1.0", "x-build-id": "eNo7art9CX9QiAEK2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~ziprecruiter-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-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/sian.agency~ziprecruiter-jobs-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-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/sian.agency~ziprecruiter-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-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": { "search": { "title": "šŸ” Search keywords", "type": "string", "description": "šŸ” **JOB TITLE / KEYWORDS:** What you're hiring for or researching, e.g. `software engineer`, `registered nurse`, `truck driver`.\n\nšŸ’” **TIP:** Combine with a **Location** below for a targeted local search. Leave Location empty for a nationwide search.\n\nUse this OR paste full **Search URLs** below ā€” at least one is required.", "default": "software engineer" }, "location": { "title": "šŸ“ Location", "type": "string", "description": "šŸ“ **LOCATION:** City + state (`Austin, TX`) or a ZIP code (`78701`). Leave empty for a nationwide search.", "default": "" }, "scrapeMode": { "title": "āš™ļø Scrape mode", "enum": [ "overview", "detail" ], "type": "string", "description": "āš™ļø **OVERVIEW vs DETAIL:**\n\n- **Overview** ā€” fast & cheap. Job title + direct link for every result (ā‰ˆ20 per search page). Best for building a list of openings.\n- **Detail** ā€” full record per job: company, location, salary band, employment type, posted/expiry dates, category, industry & full description.\n\nšŸ’” Start with **Overview** to scope a search, then run **Detail** on the slice you want.", "default": "overview" }, "maxResults": { "title": "šŸ”¢ Max results", "minimum": 1, "type": "integer", "description": "šŸ”¢ **HOW MANY JOBS TO RETURN.**\n\n- **FREE users:** up to 25 jobs per run\n- **PAID users:** unlimited\n\nResults are de-duplicated across search pages.", "default": 100 }, "startUrls": { "title": "šŸš€ Search URLs (advanced)", "uniqueItems": true, "type": "array", "description": "šŸš€ **PASTE FILTERED SEARCH URLs:** Run a search on ziprecruiter.com with the exact filters you want (radius, date posted, salary floor, employment type, remote), then paste the resulting `/jobs-search?...` URL(s) here. Every allowlisted filter is carried through pagination automatically.\n\nšŸ’” **TIP:** Use this for precise filtering the simple keyword/location fields don't cover. You can mix multiple URLs.\n\nšŸ“‹ **BULK EDIT:** Click \"Bulk edit\" to paste URLs (one per line).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "radius": { "title": "šŸ“ Radius (miles)", "type": "integer", "description": "šŸ“ Search radius in miles around the **Location** (ZipRecruiter default is 25)." }, "days": { "title": "šŸ“… Posted within (days)", "type": "integer", "description": "šŸ“… Only jobs posted within the last N days (e.g. `1`, `5`, `7`)." }, "refine_by_salary": { "title": "šŸ’° Minimum salary", "type": "integer", "description": "šŸ’° Minimum annual salary floor (e.g. `60000`). Only jobs at or above this are returned." }, "refine_by_employment": { "title": "šŸ§° Employment type", "enum": [ "", "employment_full_time", "employment_part_time", "employment_contract", "employment_temporary", "employment_internship" ], "type": "string", "description": "šŸ§° Filter by employment type.", "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 } } }, "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 } } } } } } } } } }