{ "openapi": "3.0.1", "info": { "title": "Canada Open Data Catalog Scraper", "description": "Search Canada’s official open data catalog. Export bilingual dataset titles, publishers, licenses, dates, formats, resource links, and metadata.", "version": "1.0", "x-build-id": "4j2JskC060J2QkJCD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~canada-open-data-catalog-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-canada-open-data-catalog-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/muhammadafzal~canada-open-data-catalog-scraper/runs": { "post": { "operationId": "runs-sync-muhammadafzal-canada-open-data-catalog-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/muhammadafzal~canada-open-data-catalog-scraper/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-canada-open-data-catalog-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": { "query": { "title": "Search query", "type": "string", "description": "Use this for keyword or CKAN search syntax, for example `climate change`. Leave empty only when datasetIds are supplied. Defaults to `climate change` in the prefill.", "default": "climate change" }, "datasetIds": { "title": "Exact dataset IDs", "type": "array", "description": "Use this to fetch exact Open Government dataset UUIDs, for example `2d90548d-50ef-4802-91f8-c59c5cf68251`. When set, these are fetched in addition to search results.", "default": [], "items": { "type": "string" } }, "language": { "title": "Output language", "enum": [ "en", "fr" ], "type": "string", "description": "Use this to select English or French titles, descriptions, keywords, and catalog URLs. Bilingual fields remain available. Default is English.", "default": "en" }, "organization": { "title": "Publisher organization", "type": "string", "description": "Use this to keep records whose organization slug or bilingual publisher name contains the text, for example `nrcan-rncan` or `Natural Resources Canada`. Matching is case-insensitive.", "default": "" }, "resourceFormats": { "title": "Resource formats", "type": "array", "description": "Use this to keep datasets with at least one matching resource format, for example `CSV`, `JSON`, or `GeoJSON`. Values are case-insensitive; empty means all formats.", "default": [], "items": { "type": "string" } }, "modifiedAfter": { "title": "Modified after", "type": "string", "description": "Use this to keep datasets modified on or after an ISO date or timestamp, for example `2025-01-01`. Empty means no modified-date filter.", "default": "" }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "modified_desc", "modified_asc", "title_asc" ], "type": "string", "description": "Use this to order keyword search results by relevance, newest modification time, oldest modification time, or title. Exact dataset IDs preserve the supplied order.", "default": "relevance" }, "includeResources": { "title": "Include resources", "type": "boolean", "description": "Use this to include each dataset's files, formats, download URLs, sizes, and DataStore status. Disable for smaller output records. Default is enabled.", "default": true }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Use this to cap delivered dataset records and PPE result events. Accepts 1–10,000; default is 20. Exact-ID and search results share this cap.", "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 } } } } } } } } } }