{ "openapi": "3.0.1", "info": { "title": "Job Bank Canada Jobs Scraper — Live Data", "description": "Collect live Job Bank Canada job listings in real time — keyword search, employer watchlists, full detail enrichment, and direct URL lookup. Every record streams to your dataset the moment it is collected, with optional webhook delivery.", "version": "0.0", "x-build-id": "1DPRfyhrABHmCvlb5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~Job-Bank-Canada-Real-Time-Data-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-Job-Bank-Canada-Real-Time-Data-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/b2b_leads~Job-Bank-Canada-Real-Time-Data-Scraper/runs": { "post": { "operationId": "runs-sync-b2b_leads-Job-Bank-Canada-Real-Time-Data-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/b2b_leads~Job-Bank-Canada-Real-Time-Data-Scraper/run-sync": { "post": { "operationId": "run-sync-b2b_leads-Job-Bank-Canada-Real-Time-Data-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": { "enableJobSearch": { "title": "Job search", "type": "boolean", "description": "Search live Job Bank Canada listings by keyword and location. Returns fast cards: title, employer, location, salary when shown, posting date, and job number. On by default.", "default": true }, "jobKeywords": { "title": "Job keywords", "type": "array", "description": "Keywords for the Job Bank search box, e.g. \"cook\", \"truck driver\", \"registered nurse\". One search runs per keyword.", "default": [ "cook" ], "items": { "type": "string" } }, "jobLocation": { "title": "Job location", "type": "string", "description": "Location to search in, e.g. \"Toronto\", \"Vancouver\", \"Calgary\". Leave empty to search everywhere in Canada.", "default": "" }, "jobsPerQuery": { "title": "Jobs per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap the number of jobs collected per keyword search. This is the main cost lever for job search.", "default": 10 }, "fetchFullDetails": { "title": "Fetch full details", "type": "boolean", "description": "Enrich each job row in place with its full description, salary range, employment terms, hours, vacancies, NOC code, and employer details. Every job is still exported even when details are unavailable (nothing is dropped). Adds a little extra time per record.", "default": false }, "enableCompanyJobs": { "title": "Company jobs", "type": "boolean", "description": "Collect live openings at specific employers by name, e.g. \"Air Canada\", \"Loblaws\". Runs one Job Bank search per employer. Off by default — turn on and add employer names.", "default": false }, "companyNames": { "title": "Company names", "type": "array", "description": "Employer names to collect openings for (only used when Company jobs is enabled).", "default": [], "items": { "type": "string" } }, "jobsPerCompany": { "title": "Jobs per company", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap the number of jobs collected per employer.", "default": 10 }, "enableScrapeByUrl": { "title": "Scrape by URL", "type": "boolean", "description": "Collect full job records from explicit Job Bank URLs (jobbank.gc.ca/jobsearch/jobposting/...). Off by default — turn on and paste URLs.", "default": false }, "jobUrls": { "title": "Job URLs", "type": "array", "description": "Job Bank posting page URLs to collect (only used when Scrape by URL is enabled).", "default": [], "items": { "type": "string" } }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. Every record is always saved to the run's dataset — this webhook is an ADDITIONAL real-time push. When set, each new record is also delivered to this URL (CRM, Slack incoming webhook, Zapier, Make, Google Sheets).", "default": "" }, "webhookFormat": { "title": "Webhook format", "enum": [ "json", "slack" ], "type": "string", "description": "Payload format for the webhook push: raw JSON record, or a Slack-friendly message.", "default": "json" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy for Job Bank collection. Residential Canadian proxies are recommended for the freshest results.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CA" } } } }, "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 } } } } } } } } } }