{ "openapi": "3.0.1", "info": { "title": "Toronto Building Permit Status Delta", "description": "Watches Toronto's open-data building permit registry by permit type and reports only real status changes: new active permits, status-cycle moves (Under Review, Permit Issued, Inspection, Closed...), and permits leaving the active slice (two-run confirmed). Free when nothing changes.", "version": "0.1", "x-build-id": "GsuFbdM0ZbfV9cNlz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/titan_coder~toronto-building-permit-status-delta/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-titan_coder-toronto-building-permit-status-delta", "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/titan_coder~toronto-building-permit-status-delta/runs": { "post": { "operationId": "runs-sync-titan_coder-toronto-building-permit-status-delta", "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/titan_coder~toronto-building-permit-status-delta/run-sync": { "post": { "operationId": "run-sync-titan_coder-toronto-building-permit-status-delta", "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", "required": [ "monitorId", "watches" ], "properties": { "monitorId": { "title": "Monitor ID", "pattern": "^[a-z0-9-]{1,40}$", "type": "string", "description": "Name of this monitor's durable history (a-z, 0-9, dash; up to 40 chars)." }, "watches": { "title": "Permit types to watch", "minItems": 1, "maxItems": 5, "type": "array", "description": "1-5 objects: {\"watchId\": \"rental-renovation\", \"permitType\": \"Rental Renovation Licence\"}. Each watch tracks the FULL active-permit slice for one permitType (one of the 24 exact values the City of Toronto uses in its own PERMIT_TYPE field, including its punctuation/spacing) — not a date window: a permit issued months ago that only now changes status is still caught. Because each run re-scans the whole slice, keep the number of watches small; large permit types (e.g. \"Small Residential Projects\", \"Plumbing(PS)\") take longer and cost more requests than small ones. New watches can be added later under the same monitorId.", "items": { "type": "object", "required": [ "watchId", "permitType" ], "properties": { "watchId": { "title": "Watch ID", "type": "string", "description": "Your own stable label for this watch: lowercase letters, digits and hyphens, up to 60 characters.", "pattern": "^[a-z0-9-]{1,60}$" }, "permitType": { "title": "Permit type", "type": "string", "description": "Exact PERMIT_TYPE value from the City of Toronto's own \"Building Permits - Active Permits\" open dataset (spelling/punctuation matches the source, e.g. \"Mechanical(MS)\" without a space).", "enum": [ "AS Alternative Solution", "Building Additions/Alterations", "Building Historical data - Converted", "Conditional Permit", "DCs DeferredFees", "Demolition Folder (DM)", "Designated Structures", "Drain and Site Service", "Fire/Security Upgrade", "Mechanical(MS)", "Multiple Use Permit", "New Building", "New Houses", "Non-Residential Building Permit", "Partial Permit", "Plumbing(PS)", "Portable Classrooms", "Rental Renovation Licence", "Residential Building Permit", "Site Inspection(Scarborough)", "Small Residential Projects", "Temporary Structures", "Toronto Building Standard Attachments", "Toronto Buildings Contacts" ] } } }, "default": [ { "watchId": "rental-renovation", "permitType": "Rental Renovation Licence" } ] }, "maxResultsPerWatch": { "title": "Max changed records per watch per run", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Caps how many new/status-changed/removed permits are delivered per watch in a single run (the rest are picked up on the next run). Protects against a runaway bill on a watch's very first post-baseline run.", "default": 200 }, "notifyOn": { "title": "Send webhook", "enum": [ "new_alerts", "always", "never" ], "type": "string", "description": "new_alerts — post the webhook only when billed status changes were delivered; always — post it every run; never — do not call webhookUrl at all.", "default": "new_alerts" }, "webhookUrl": { "title": "Webhook URL (HTTPS)", "type": "string", "description": "Optional. Receives a digest of delivered (billed) permit status changes as JSON. HTTPS only." } } }, "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 } } } } } } } } } }