{
  "openapi": "3.0.1",
  "info": {
    "title": "ZipRecruiter Job Scraper | 5 Markets, Contacts & Monitoring",
    "description": "Extract job listings from ZipRecruiter across Ireland, UK, Germany, France and India. Get structured salary, geo-coordinates, employer contacts, and full descriptions in text/HTML/Markdown with incremental change monitoring.",
    "version": "0.1",
    "x-build-id": "xp8IeGWgsXygaxcZi"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/corvuslab~ziprecruiter-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-corvuslab-ziprecruiter-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/corvuslab~ziprecruiter-scraper/runs": {
      "post": {
        "operationId": "runs-sync-corvuslab-ziprecruiter-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/corvuslab~ziprecruiter-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-corvuslab-ziprecruiter-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": {
          "query": {
            "title": "🔑 Search keywords",
            "type": "string",
            "description": "Keywords to search for. Separate multiple searches with commas — each runs as its own search and results are merged and de-duplicated."
          },
          "country": {
            "title": "🌍 Country",
            "enum": [
              "IE",
              "GB",
              "DE",
              "FR",
              "IN",
              "US"
            ],
            "type": "string",
            "description": "Which ZipRecruiter market to search.",
            "default": "IE"
          },
          "location": {
            "title": "📍 Location",
            "type": "string",
            "description": "City, region or area to search in. Leave empty for country-wide results (in the United States: nationwide)."
          },
          "startUrls": {
            "title": "📋 Start URLs",
            "type": "array",
            "description": "Paste ZipRecruiter search or job-detail URLs to scrape directly.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxResults": {
            "title": "🔢 Max results",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of records to return. Set 0 for everything the search has (up to 10,000 per search). In incremental mode this is the number of top results watched each run.",
            "default": 25
          },
          "ignoreUrlFailures": {
            "title": "⏭️ Ignore URL failures",
            "type": "boolean",
            "description": "Skip URLs that cannot be interpreted instead of failing the whole run.",
            "default": true
          },
          "jobType": {
            "title": "💼 Job type",
            "enum": [
              "",
              "full_time",
              "part_time",
              "permanent",
              "contract",
              "temporary",
              "internship"
            ],
            "type": "string",
            "description": "Keep only jobs of this type. Matched on each posting's own employment type in every market's language (e.g. Vollzeit, CDI), so full details are fetched when this is set. In the United States the search applies it directly, and Permanent means full-time.",
            "default": ""
          },
          "sort": {
            "title": "🔀 Sort order",
            "enum": [
              "",
              "date"
            ],
            "type": "string",
            "description": "How to sort search results.",
            "default": ""
          },
          "remoteFilter": {
            "title": "🏠 Workplace",
            "enum": [
              "",
              "on_site",
              "remote",
              "hybrid",
              "remote_or_hybrid"
            ],
            "type": "string",
            "description": "Filter by work arrangement. On-site only is applied by the search itself; remote and hybrid are read from each posting's full text. In the United States every option is read from the job's own workplace type, with no extra page loads.",
            "default": ""
          },
          "radius": {
            "title": "📡 Search radius (km)",
            "minimum": 0,
            "type": "integer",
            "description": "Search radius around the location in kilometres. Only used when a location is set. Values snap to the nearest option: 5, 10, 20, 50 or 100 km (United States: 5, 10, 25, 50 or 100 miles)."
          },
          "postedWithinDays": {
            "title": "📅 Posted within (days)",
            "minimum": 1,
            "maximum": 365,
            "type": "integer",
            "description": "Keep only jobs posted in the last N days. Leave empty for any age. Results are then collected newest-first."
          },
          "minSalary": {
            "title": "💰 Minimum yearly pay",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only jobs whose pay reaches this yearly amount at the top of its range, in the market's own currency (e.g. 60000). Hourly, daily, weekly and monthly pay is converted to a yearly figure. Jobs that state no pay are left out."
          },
          "experienceLevel": {
            "title": "🎓 Experience level (US)",
            "enum": [
              "",
              "junior",
              "mid",
              "senior"
            ],
            "type": "string",
            "description": "United States only: keep jobs ZipRecruiter classifies as junior, mid-level or senior. Ignored in other markets.",
            "default": ""
          },
          "applyMethod": {
            "title": "🖱️ Apply method",
            "enum": [
              "",
              "easy_apply",
              "external"
            ],
            "type": "string",
            "description": "Easy apply keeps US jobs you apply to directly on ZipRecruiter (1-Click Apply); external keeps jobs that send you to the employer's own site. Outside the US every job applies on the employer's site.",
            "default": ""
          },
          "requireContact": {
            "title": "📇 Require contact details",
            "enum": [
              "off",
              "email",
              "phone",
              "either",
              "both"
            ],
            "type": "string",
            "description": "Keep only records that include a contact. off = keep everything; email / phone = require that channel; either = at least one; both = email and phone.",
            "default": "off"
          },
          "includeDetails": {
            "title": "🔬 Fetch full details",
            "type": "boolean",
            "description": "Fetch each job's detail page for richer fields. Turn off for the fastest, cheapest runs.",
            "default": true
          },
          "descriptionFormat": {
            "title": "📝 Description format",
            "enum": [
              "all",
              "text",
              "html",
              "markdown"
            ],
            "type": "string",
            "description": "Which representation(s) of the job description to include.",
            "default": "all"
          },
          "descriptionMaxLength": {
            "title": "✂️ Description max length",
            "minimum": 0,
            "type": "integer",
            "description": "Truncate description to N characters. 0 = no truncation.",
            "default": 0
          },
          "compact": {
            "title": "📦 Compact records",
            "type": "boolean",
            "description": "Emit only the core fields. Ideal for AI agents and MCP clients.",
            "default": false
          },
          "excludeEmptyFields": {
            "title": "🧹 Drop empty fields",
            "type": "boolean",
            "description": "Remove null, empty-string and empty-array fields from each record.",
            "default": false
          },
          "incrementalMode": {
            "title": "♻️ Incremental mode",
            "type": "boolean",
            "description": "Track state between runs and tag every record with a changeType (NEW / UPDATED / REAPPEARED / UNCHANGED / EXPIRED).",
            "default": false
          },
          "stateKey": {
            "title": "🗝️ State key",
            "type": "string",
            "description": "Stable name for the tracked search. Leave empty to derive one automatically from your search settings."
          },
          "emitUnchanged": {
            "title": "🔁 Include unchanged records",
            "type": "boolean",
            "description": "Also emit records that have not changed since the previous run.",
            "default": false
          },
          "emitExpired": {
            "title": "🗑️ Include expired records",
            "type": "boolean",
            "description": "Emit records for jobs present last run but gone now.",
            "default": false
          },
          "skipReposts": {
            "title": "🔂 Skip reposts",
            "type": "boolean",
            "description": "Drop jobs that are a re-listing of one already seen (same title at the same employer under a new job ID). Reposts are always flagged with isRepost either way.",
            "default": false
          },
          "telegramToken": {
            "title": "💬 Telegram bot token",
            "type": "string",
            "description": "Bot token from @BotFather."
          },
          "telegramChatId": {
            "title": "🆔 Telegram chat ID",
            "type": "string",
            "description": "Chat or channel ID, e.g. \"-100123456789\" or \"@yourchannel\"."
          },
          "slackWebhookUrl": {
            "title": "💼 Slack webhook URL",
            "type": "string",
            "description": "Slack incoming-webhook URL."
          },
          "discordWebhookUrl": {
            "title": "🎮 Discord webhook URL",
            "type": "string",
            "description": "Discord incoming-webhook URL."
          },
          "whatsappPhoneNumberId": {
            "title": "🟢 WhatsApp phone number ID",
            "type": "string",
            "description": "WhatsApp Cloud API phone number ID (Meta for Developers → WhatsApp → API setup)."
          },
          "whatsappAccessToken": {
            "title": "🔐 WhatsApp access token",
            "type": "string",
            "description": "WhatsApp Cloud API access token."
          },
          "whatsappTo": {
            "title": "📱 WhatsApp recipient(s)",
            "type": "string",
            "description": "Recipient phone number(s) in international format, comma-separated, e.g. \"353871234567\". Meta delivers free-form messages to numbers that messaged your business number in the last 24 hours."
          },
          "webhookUrl": {
            "title": "🪝 Webhook URL",
            "type": "string",
            "description": "Any HTTPS endpoint. Receives a JSON POST with the matched records — works with n8n, Make and Zapier."
          },
          "webhookHeaders": {
            "title": "🧾 Webhook headers",
            "type": "object",
            "description": "Extra headers for the webhook request, e.g. {\"Authorization\": \"Bearer xyz\"}."
          },
          "notificationLimit": {
            "title": "🔢 Records per notification",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many records to include in each notification message.",
            "default": 5
          },
          "notifyOnlyChanges": {
            "title": "🆕 Notify only about changes",
            "type": "boolean",
            "description": "In incremental mode, send only NEW, UPDATED and REAPPEARED jobs to your channels.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "🌐 Proxy configuration",
            "type": "object",
            "description": "The default setting works out of the box — only change it if you have a reason to.",
            "default": {
              "useApifyProxy": true
            }
          },
          "maxRequestRetries": {
            "title": "🔄 Max request retries",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "How many times to retry a failed request before giving up on it.",
            "default": 3
          },
          "detailConcurrency": {
            "title": "⚡ Parallel job pages",
            "minimum": 1,
            "maximum": 32,
            "type": "integer",
            "description": "How many job pages to load at once when fetching full details.",
            "default": 16
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}