{ "openapi": "3.0.1", "info": { "title": "Canada Aircraft Mark Monitor: CCAR Status & Sale Alerts", "description": "Watch Canadian aircraft by registration mark (C-XXXX); get an event when registration is cancelled or expires, a sale is reported or the owner changes, from the official Transport Canada CCAR daily file. Pay per change.", "version": "0.1", "x-build-id": "jqnwIyzfBtBaqojmU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plym-actor-factory~ca-tc-ccar-aircraft-mark-portfolio-status-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plym-actor-factory-ca-tc-ccar-aircraft-mark-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-tc-ccar-aircraft-mark-portfolio-status-monitor/runs": { "post": { "operationId": "runs-sync-plym-actor-factory-ca-tc-ccar-aircraft-mark-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-tc-ccar-aircraft-mark-portfolio-status-monitor/run-sync": { "post": { "operationId": "run-sync-plym-actor-factory-ca-tc-ccar-aircraft-mark-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": { "marks": { "title": "Registration marks (examples — replace with your own)", "type": "array", "description": "Canadian aircraft registration marks to watch, e.g. C-FCEU, CFCEU or FCEU (the C- prefix is optional). Examples: C-FCEU (Air Canada A321), C-FAJA (WestJet 787-9), C-GKQA (Porter DHC-8-402), C-FBBO (Conair AT-802A).", "items": { "type": "string", "minLength": 3, "maxLength": 10 } }, "registrationMarks": { "title": "Registration marks (alias)", "type": "array", "description": "Optional alias merged into the watchlist.", "items": { "type": "string" } }, "tailNumbers": { "title": "Tail numbers (alias)", "type": "array", "description": "Optional alias merged into the watchlist.", "items": { "type": "string" } }, "signalGroups": { "title": "Signal groups", "type": "array", "description": "directory (APPEARED/DROPPED from the register download), status (STATUS_CHANGED: Registered / Registration Cancelled / Registration Expired), sale (SALE_REPORTED flag set), owner (OWNER_CHANGED; organisation owners named, individual owners counted only), operations (PURPOSE_CHANGED Private/Commercial/State, FLIGHT_AUTHORITY_CHANGED, BASE_CHANGED province; opt-in). Default: directory+status+sale+owner.", "default": [ "directory", "status", "sale", "owner" ], "items": { "type": "string" } }, "maxRunSeconds": { "title": "Max run seconds", "minimum": 5, "maximum": 900, "type": "integer", "description": "Wall-clock budget.", "default": 120 }, "maxEvents": { "title": "Max delivered change events", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many unique change events are delivered (RUN_STATUS excluded).", "default": 500 }, "resumeFromCheckpoint": { "title": "Resume from stored checkpoint", "type": "boolean", "description": "If true, resume aircraft snapshots and seen event_uids from the default Key-Value Store (keep the same Task).", "default": true }, "sourceMode": { "title": "Source mode", "enum": [ "fixture", "live" ], "type": "string", "description": "fixture = free Store/CI health check (no network; one non-billable RUN_STATUS row unless emitFixtureDemoEvents=true). live = official Transport Canada CCAR daily download (no API key; ~5 MB zip). Fixture demo rows use placeholder aircraft, are flagged sample=true / isSample=true, billable=false, and are never charged.", "default": "fixture" }, "emitFixtureDemoEvents": { "title": "Emit fixture demo change events", "type": "boolean", "description": "When sourceMode=fixture, emit SAMPLE demo events from local fixtures (placeholder aircraft, never charged). Default false.", "default": false }, "maxTotalChargeUsd": { "title": "Max total charge (USD)", "minimum": 0, "type": "number", "description": "Optional soft budget hint." }, "asOfHint": { "title": "as_of hint (YYYY-MM-DD)", "type": "string", "description": "Optional as_of label (defaults to the CCAR download Last-Modified date)." }, "registerZipUrl": { "title": "CCAR download URL override", "type": "string", "description": "Optional override for the official CCAR database zip 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 } } } } } } } } } }