{ "openapi": "3.0.1", "info": { "title": "Canada OSFI Monitor: Regulated Bank & Insurer Alerts", "description": "Watch OSFI-regulated Canadian banks, insurers and trust companies in the official monthly Who We Regulate list. Get an alert when an institution appears, drops off or changes classification. Pay per change.", "version": "0.1", "x-build-id": "HKaI2jbRpnRrjki5J" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plym-actor-factory~ca-osfi-frfi-who-we-regulate-portfolio-status-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plym-actor-factory-ca-osfi-frfi-who-we-regulate-portfolio-status-monitor", "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/plym-actor-factory~ca-osfi-frfi-who-we-regulate-portfolio-status-monitor/runs": { "post": { "operationId": "runs-sync-plym-actor-factory-ca-osfi-frfi-who-we-regulate-portfolio-status-monitor", "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/plym-actor-factory~ca-osfi-frfi-who-we-regulate-portfolio-status-monitor/run-sync": { "post": { "operationId": "run-sync-plym-actor-factory-ca-osfi-frfi-who-we-regulate-portfolio-status-monitor", "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": { "companyNames": { "title": "OSFI FRFI company names (watchlist)", "type": "array", "description": "Canada OSFI federally regulated financial institution company names to monitor against the official monthly Who we regulate CSV (e.g. Royal Bank of Canada). Optional Name|FI Industry composites disambiguate the rare duplicate names. Invalid entries skipped with no charge. Not a national OSFI dump bill.", "default": [ "Royal Bank of Canada", "Toronto-Dominion Bank", "Bank of Nova Scotia", "Canadian Imperial Bank of Commerce" ], "items": { "type": "string" } }, "frfiIds": { "title": "frfiIds alias (optional)", "type": "array", "description": "Optional alias for companyNames — same durable FRFI identifiers, merged into the watchlist.", "items": { "type": "string" } }, "signalGroups": { "title": "Signal groups", "type": "array", "description": "Which change groups to evaluate: directory (APPEARED/DROPPED), status (FI_GROUP_CHANGED/FI_INDUSTRY_CHANGED/FI_TYPE_CHANGED), attributes (REPRESENTATIVE_CHANGED/ADDRESS_CHANGED/TRADE_NAME_CHANGED). Default: directory+status.", "default": [ "directory", "status" ], "items": { "type": "string" } }, "maxRunSeconds": { "title": "Max run seconds", "minimum": 5, "maximum": 900, "type": "integer", "description": "Wall-clock budget (CSV download + parse + watchlist diff).", "default": 180 }, "maxEvents": { "title": "Max delivered change events", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many unique change events are delivered (does not include RUN_STATUS).", "default": 500 }, "resumeFromCheckpoint": { "title": "Resume from stored checkpoint", "type": "boolean", "description": "If true, resume FRFI snapshots and seen event_uids from the default Key-Value Store.", "default": true }, "sourceMode": { "title": "Source mode", "enum": [ "fixture", "live" ], "type": "string", "description": "fixture = Store/CI health default (no network; RUN_STATUS only unless emitFixtureDemoEvents=true). live = official OSFI monthly who_we_regulate_fi_eng.csv (no API key; monthly publish lag).", "default": "fixture" }, "emitFixtureDemoEvents": { "title": "Emit fixture demo change events", "type": "boolean", "description": "When sourceMode=fixture, if true push fabricated change events from local fixtures. Default false so Store daily auto-tests never emit fake OSFI events or charge osfi-frfi-status-event-delivered.", "default": false }, "maxTotalChargeUsd": { "title": "Max total charge (USD)", "minimum": 0, "type": "number", "description": "Optional soft budget hint for delivered change events." }, "asOfHint": { "title": "as_of hint (YYYY-MM-DD)", "type": "string", "description": "Optional as_of label for events / RUN_STATUS. Defaults to Last-Modified date from the CSV response when present." }, "osfiRegisterCsvUrl": { "title": "OSFI Who we regulate CSV URL override", "type": "string", "description": "Optional override for the official open.canada Who we regulate financial institutions English CSV URL." } } }, "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 } } } } } } } } } }