{ "openapi": "3.0.1", "info": { "title": "Job Bank Canada Scraper", "description": "Jobs from Job Bank, the Government of Canada's job board, with the wage as numbers, hours per week, vacancies, education, experience and the workplace address. Search by keyword and province, filter by date, terms and language, and flag jobs open to international candidates.", "version": "0.1", "x-build-id": "NkgbZzSA9jGmzaK9R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deriverge~job-bank-canada-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deriverge-job-bank-canada-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/deriverge~job-bank-canada-scraper/runs": { "post": { "operationId": "runs-sync-deriverge-job-bank-canada-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/deriverge~job-bank-canada-scraper/run-sync": { "post": { "operationId": "run-sync-deriverge-job-bank-canada-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": "Keywords", "type": "array", "description": "What to search for, as in the Job Bank search box: a job title, occupation or skill, for example \"cook\", \"truck driver\", \"registered nurse\" or \"software developer\". Each keyword is its own search. Leave empty for all jobs.", "items": { "type": "string" } }, "provinces": { "title": "Provinces and territories", "type": "array", "description": "Only jobs in these provinces or territories. Leave empty for all of Canada.", "items": { "type": "string", "enum": [ "AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT" ], "enumTitles": [ "Alberta", "British Columbia", "Manitoba", "New Brunswick", "Newfoundland and Labrador", "Northwest Territories", "Nova Scotia", "Nunavut", "Ontario", "Prince Edward Island", "Quebec", "Saskatchewan", "Yukon" ] } }, "cities": { "title": "Cities", "type": "array", "description": "Only jobs in any of these cities, for example Toronto, Calgary or Vancouver. Combine with a province for faster runs.", "items": { "type": "string" } }, "postedWithin": { "title": "Posted", "enum": [ "any", "2", "30" ], "type": "string", "description": "Only jobs posted in this window, as on the website.", "default": "any" }, "employmentTerms": { "title": "Employment terms", "type": "array", "description": "Only jobs with any of these terms. Leave empty for all.", "items": { "type": "string", "enum": [ "permanent", "term", "seasonal", "casual" ], "enumTitles": [ "Permanent", "Term or contract", "Seasonal", "Casual" ] } }, "language": { "title": "Language of work", "enum": [ "any", "english", "french", "bilingual" ], "type": "string", "description": "Only jobs in this language of work.", "default": "any" }, "source": { "title": "Source", "enum": [ "all", "jobBank", "partners" ], "type": "string", "description": "Job Bank also lists jobs from partner job boards such as Indeed or CareerBeacon. Jobs posted on Job Bank have the most fields.", "default": "all" }, "openToInternationalOnly": { "title": "Open to international candidates", "type": "boolean", "description": "Only jobs where employers also accept candidates from outside Canada, as the website filter \"Canadians and international candidates\".", "default": false }, "includeDetails": { "title": "Include full details", "type": "boolean", "description": "Reads each job page for the address, hours per week, vacancies, employment terms, schedule, languages, education, experience, description and whether international candidates can apply. The price is the same, but each job adds 5 seconds (see Maximum jobs).", "default": true }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop jobs whose title or employer contains any of these.", "items": { "type": "string" } }, "newOnly": { "title": "Return only jobs new since the last run", "type": "boolean", "description": "Keeps a snapshot per watch name (or per saved task) and returns only jobs that were not there before. Schedule it daily for a job alert.", "default": false }, "watchName": { "title": "Watch name", "type": "string", "description": "Name of the snapshot used by the new-only mode, for example \"cooks-alberta\". Runs from a saved task get one automatically." }, "maxItems": { "title": "Maximum jobs", "minimum": 1, "type": "integer", "description": "Hard cap on returned jobs. Job Bank asks automated visitors to wait 5 seconds between pages, and the scraper keeps to that: 100 jobs with full details take about 9 minutes, without details about 25 seconds (25 jobs per page).", "default": 100 } } }, "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 } } } } } } } } } }