{ "openapi": "3.0.1", "info": { "title": "HelloWork Jobs Scraper - Salaries & New-Job Alerts", "description": "Scrape job ads from HelloWork, one of France's largest job boards: title, company, city, contract type, parsed salary (incl. HelloWork's own salary estimates), education, experience and full description. Monitoring mode returns only jobs you haven't seen before.", "version": "0.1", "x-build-id": "adTvN1z69yOmWxvmW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mftira~hellowork-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mftira-hellowork-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/mftira~hellowork-jobs-scraper/runs": { "post": { "operationId": "runs-sync-mftira-hellowork-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/mftira~hellowork-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-mftira-hellowork-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": { "searchQueries": { "title": "Job titles or keywords", "type": "array", "description": "One search per entry, e.g. \"développeur\", \"comptable\", \"infirmier\". Leave empty if you only use HelloWork search URLs below.", "default": [ "développeur" ], "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "City, department or region, e.g. \"Lyon\", \"Paris\", \"Bretagne\". Leave empty for all of France." }, "contractTypes": { "title": "Contract types", "type": "array", "description": "Only these contract types. Leave empty for all.", "items": { "type": "string", "enum": [ "CDI", "CDD", "Interim", "Alternance", "Stage", "Independant" ], "enumTitles": [ "CDI", "CDD", "Intérim", "Alternance", "Stage", "Indépendant" ] } }, "maxAgeDays": { "title": "Posted within (days)", "minimum": 0, "maximum": 365, "type": "integer", "description": "Only jobs posted in the last N days. 0 = any age.", "default": 0 }, "sortByDate": { "title": "Newest first", "type": "boolean", "description": "Sort results by publication date instead of relevance. Always on when an age limit or monitoring mode is used.", "default": false }, "startUrls": { "title": "HelloWork search URLs (optional)", "type": "array", "description": "Paste any HelloWork search-results URL with the filters you set on the website.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Maximum jobs", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many jobs in total (across all searches).", "default": 100 }, "includeDetails": { "title": "Include full job descriptions", "type": "boolean", "description": "Opens each job ad for the full description, candidate profile, company description, exact publication date, education level, experience, sector and HelloWork's salary estimate. Charged as an extra event per job.", "default": false }, "onlyNewJobs": { "title": "Only new jobs (monitoring mode)", "type": "boolean", "description": "Skip jobs returned by earlier runs with the same monitoring key. Schedule this Actor daily to get a feed of fresh ads only — you're never charged twice for the same job.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for the list of already-seen jobs. Use a different key for each independent feed (e.g. \"lyon-dev\", \"paris-compta\").", "default": "default" }, "maxPagesPerQuery": { "title": "Max pages per search", "minimum": 1, "maximum": 400, "type": "integer", "description": "Safety cap on result pages per search (30 jobs per page).", "default": 50 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. The default Apify Proxy works well." } } }, "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 } } } } } } } } } }