{ "openapi": "3.0.1", "info": { "title": "Health Canada Recalls & Safety Alerts Scraper", "description": "Scrape Health Canada recalls and safety alerts: food, consumer products, vehicles and health/drug products. Filter by category, keyword, date and audience. Get firm, hazard, distribution, UPCs and lot codes.", "version": "0.1", "x-build-id": "0SUHXu16gmbWqAfKd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~health-canada-recalls-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-health-canada-recalls-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/scrapers_lat~health-canada-recalls-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-health-canada-recalls-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/scrapers_lat~health-canada-recalls-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-health-canada-recalls-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": { "maxRecalls": { "title": "Max recalls", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of recall / safety-alert records to collect." }, "searchKeyword": { "title": "Search keyword", "type": "string", "description": "Full-text search across the Health Canada recall database (product, brand, hazard, firm, e.g. 'salmonella', 'listeria', 'airbag', 'Honda', 'undeclared milk'). Leave empty to pull the most recent recalls." }, "category": { "title": "Category", "enum": [ "", "food", "consumer-products", "health-products", "vehicles" ], "type": "string", "description": "Restrict to one recall category. Leave as 'All' to include every category.", "default": "" }, "recallDateStart": { "title": "Recall date from (YYYY-MM-DD)", "type": "string", "description": "Only keep recalls published on or after this date. Optional. Format YYYY-MM-DD." }, "recallDateEnd": { "title": "Recall date to (YYYY-MM-DD)", "type": "string", "description": "Only keep recalls published on or before this date. Optional. Format YYYY-MM-DD." }, "audience": { "title": "Audience filter", "type": "string", "description": "Optional. Only keep recalls whose intended audience matches this text (e.g. 'General public', 'Health professionals', 'Industry'). Applied to the detailed record, so it requires 'Fetch full detail' to be on." }, "hazard": { "title": "Hazard / issue filter", "type": "string", "description": "Optional. Only keep recalls whose hazard / issue classification contains this text (e.g. 'Salmonella', 'Listeria', 'choking', 'fire', 'undeclared'). Applied to the detailed record, so it requires 'Fetch full detail' to be on." }, "withDetails": { "title": "Fetch full detail (recommended)", "type": "boolean", "description": "Fetch each recall's detail page to add recalling firm, hazard classification, distribution regions, remedy, full issue text, affected products with UPCs & lot codes, and images. Turn off to return the fast listing-level fields only.", "default": true }, "withAiSummary": { "title": "AI recall summary (paid add-on)", "type": "boolean", "description": "Optional paid AI add-on, off by default. Writes a plain-English summary of each recall (what, the hazard, what to do) from its detail text. Requires detail enrichment and a paid Apify plan. Billed only when a summary is produced.", "default": false }, "withAiRisk": { "title": "AI hazard risk assessment (paid add-on)", "type": "boolean", "description": "Optional paid AI add-on, off by default. Classifies each recall's hazard severity, hazard type and at-risk groups from its detail text. Requires detail enrichment and a paid Apify plan. Billed only when produced.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Defaults to Apify Residential proxy in Canada, which is the most reliable way to reach the source from a datacenter.", "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 } } }, "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 } } } } } } } } } }