{ "openapi": "3.0.1", "info": { "title": "HelloWork Scraper: French Job Board", "description": "Scrape HelloWork jobs by keyword, city, contract type, salary range. Get title, company, location, contract (CDI/CDD/alternance/stage), salary, remote policy, full description, posted date. France's #1 generalist job board. For ATS providers, recruitment agencies, sourcing teams. $1/1K jobs.", "version": "1.0", "x-build-id": "oWxavqabzd027c4kg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dltik~hellowork-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dltik-hellowork-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/dltik~hellowork-scraper/runs": { "post": { "operationId": "runs-sync-dltik-hellowork-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/dltik~hellowork-scraper/run-sync": { "post": { "operationId": "run-sync-dltik-hellowork-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": { "keywords": { "title": "Search keywords", "type": "array", "description": "Job search keywords (e.g. 'developpeur python', 'commercial', 'data analyst').", "items": { "type": "string" }, "default": [] }, "location": { "title": "Location (optional)", "type": "string", "description": "City or department (e.g. 'Paris', 'Lyon', 'Bordeaux')." }, "contractTypes": { "title": "Contract types (optional)", "type": "array", "description": "Filter by contract: CDI, CDD, Stage, Alternance, Freelance, Interim, etc.", "items": { "type": "string" }, "default": [] }, "remote": { "title": "Remote policy (optional)", "enum": [ "any", "full", "partial", "occasional", "no" ], "type": "string", "description": "Filter jobs by remote policy.", "default": "any" }, "minSalary": { "title": "Minimum yearly salary (optional)", "minimum": 0, "type": "integer", "description": "Filter jobs with min annual salary above this amount (€)." }, "enrichDetails": { "title": "Enrich with full job details (premium)", "type": "boolean", "description": "Fetch each job's detail page and parse its JobPosting structured data: full description, required skills, sector, job function, years of experience, education level, employment type, structured salary (min/max/period), company URL + logo, and full postal address. Slower and billed as a separate 'job-enriched' event on top of 'job-scraped'.", "default": false }, "enrichCompany": { "title": "Enrich hiring company (premium)", "type": "boolean", "description": "Resolve each hiring company against the official French company registry (recherche-entreprises.api.gouv.fr) and attach a 'company_registry' object: SIREN, legal status, NAF/sector, workforce band, latest revenue & net result, and directors. Turns a job feed into company intelligence. Billed as a separate 'company-enriched' event, charged once per distinct company. Works best with 'Enrich with full job details' on (gives a postal code for a sharper match).", "default": false }, "skipReposts": { "title": "Skip reposts (cross-run dedup)", "type": "boolean", "description": "Exclude offers already seen in your previous runs of this actor. HelloWork re-publishes the same opening under a new id, so we fingerprint by company + title + department (90-day memory) and drop repeats — you only pay for genuinely new offers. Ideal for daily monitoring pipelines.", "default": false }, "analyzeJobs": { "title": "AI match analysis (premium)", "type": "boolean", "description": "Enrich each offer with an AI 'ai' object: a plain-language summary, the concrete required skills, an inferred seniority, and a recommended action (apply / maybe / skip). Add a 'Candidate profile' below to also get a 0-100 relevance score per offer — turns a long result list into a ranked shortlist. Requires a paid Apify plan; billed as a separate 'job-analyzed' event. If not on a paid plan the scrape still runs without analysis.", "default": false }, "candidateProfile": { "title": "Candidate profile (for AI relevance scoring)", "type": "string", "description": "One or two sentences describing the candidate (or the role you are sourcing for), e.g. 'Developpeur Python/Django, 4 ans d'experience, cherche CDI remote a Lyon' or 'Je recrute un commercial B2B SaaS senior, secteur tech, Paris'. When set (and AI analysis is on), each offer gets a relevance_score (0-100) and a one-line reason for how well it fits. Leave empty to get summaries only." }, "maxResults": { "title": "Max results per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum jobs per keyword. HelloWork paginates at 30 per page. Aliases accepted: 'limit', 'max'. Each result charged at the per-event price — start small to validate output.", "default": 20 } } }, "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 } } } } } } } } } }