{ "openapi": "3.0.1", "info": { "title": "Canada Job Bank Data API: Job Postings, NOC Codes & Salaries", "description": "Canada Job Bank data from the official monthly open data (OGL-Canada): Canada job postings with NOC 2021 codes, salary ranges, province, city and vacancies. Filter by month, job title, NOC code, province, city, employment type and wage. Canadian labour-market data as CSV, JSON or Excel.", "version": "0.1", "x-build-id": "k40dUIbodv1n57YBT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yourevenings~canada-job-bank-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yourevenings-canada-job-bank-data", "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/yourevenings~canada-job-bank-data/runs": { "post": { "operationId": "runs-sync-yourevenings-canada-job-bank-data", "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/yourevenings~canada-job-bank-data/run-sync": { "post": { "operationId": "run-sync-yourevenings-canada-job-bank-data", "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": { "months": { "title": "Months", "type": "array", "description": "Data months to read, as YYYY-MM (e.g. 2026-09), \"latest\" for the newest published month, or \"latest-3\" for the newest three. Files are published monthly, starting January 2023. Up to 12 months per run.", "default": [ "latest" ], "items": { "type": "string" } }, "keywords": { "title": "Job title contains", "type": "array", "description": "Keep postings whose job title contains any of these words, e.g. \"nurse\" or \"welder\". Accents and case are ignored.", "items": { "type": "string" } }, "nocCodes": { "title": "NOC 2021 codes", "type": "array", "description": "National Occupational Classification 2021 codes or their first digits, e.g. \"31301\" (registered nurses) or \"72\" (trades). A posting matches if its NOC 2021 code starts with any of these.", "items": { "type": "string" } }, "provinces": { "title": "Provinces and territories", "type": "array", "description": "Names or two-letter codes, e.g. \"Ontario\", \"BC\" or \"QC\".", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "City names as written in the data, e.g. \"Toronto\" or \"Montréal\" (accents and case are ignored).", "items": { "type": "string" } }, "employmentTypes": { "title": "Employment types", "type": "array", "description": "Full time, Part time or Part time leading to full time. \"Part time\" also matches \"Part time leading to full time\".", "items": { "type": "string" } }, "postedVia": { "title": "Posted via", "enum": [ "all", "jobBank", "external" ], "type": "string", "description": "External-board postings carry fewer details: in the September 2026 file almost all stated a salary, but most had no hours and none had education or experience.", "default": "all" }, "salaryPer": { "title": "Salary period", "enum": [ "Hour", "Day", "Week", "Bi-weekly", "Month", "Year" ], "type": "string", "description": "Keep only postings that state pay for this period. Needed when you set a minimum salary." }, "minSalary": { "title": "Minimum salary (CAD)", "minimum": 0, "type": "number", "description": "Keep only postings whose minimum pay for the salary period is at least this, e.g. 25 per Hour or 60000 per Year." }, "teleworkOnly": { "title": "Telework only", "type": "boolean", "description": "Keep only postings flagged for telework. Recent files flag very few postings, so this often returns nothing.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Stop after this many postings. A full month has around 50,000 to 110,000 postings.", "default": 100 }, "monitorMode": { "title": "Monitor mode (new months only)", "type": "boolean", "description": "Remember months already returned and skip them on later runs. Schedule weekly to get each new month once, about a month after it ends. A small alert fee is charged only on runs that return rows from a new month.", "default": false }, "emitBaselineOnFirstRun": { "title": "Return current months on the first monitor run", "type": "boolean", "description": "Turn off to remember the chosen months silently on the first monitor run (nothing charged per posting) and get only later months.", "default": true }, "stateStoreName": { "title": "Monitor state store", "type": "string", "description": "Named key-value store that remembers months already returned. Use a different name for each saved search.", "default": "canada-job-bank-data-state" } } }, "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 } } } } } } } } } }