{ "openapi": "3.0.1", "info": { "title": "Colorado DORA Professional License Status Delta", "description": "Tracks Colorado DORA's statewide professional license registry (nurses, cosmetologists, plumbers, engineers, 300+ license types) and alerts only on new licenses, status changes (active/expired/revoked/suspended), and confirmed removals since your last check.", "version": "0.1", "x-build-id": "GqlGI2bgxhcyjOF4g" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/titan_coder~co-dora-professional-license-status-delta/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-titan_coder-co-dora-professional-license-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~co-dora-professional-license-status-delta/runs": { "post": { "operationId": "runs-sync-titan_coder-co-dora-professional-license-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~co-dora-professional-license-status-delta/run-sync": { "post": { "operationId": "run-sync-titan_coder-co-dora-professional-license-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", "userAgentContact", "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)." }, "userAgentContact": { "title": "Your contact (email or link)", "type": "string", "description": "Sent as a descriptive, identifiable User-Agent on every request to data.colorado.gov (polite-scraping practice) — the Socrata open-data API does not require a key, but we still identify ourselves. Give your email or a contact link. Not a secret." }, "watches": { "title": "License types to watch", "minItems": 1, "maxItems": 5, "type": "array", "description": "1-5 objects: {\"watchId\": \"cosmetology\", \"licenseType\": \"COS\"}. licenseType is DORA's own short code for one license category (e.g. RN = Registered Nurse, COS = Cosmetologist, PE = Professional Engineer, REG = Real Estate Broker — see README for the full list of 300+ codes and how to look one up). Each watch tracks the FULL current population of that one license type and reports every new license, every status change (Active/Expired/Revoked/Suspended/Surrendered/...), and every confirmed removal. New watches can be added later under the same monitorId. Pick a narrow license type for faster, cheaper runs — the largest types (RN, NA) have 100,000+ rows.", "items": { "type": "object", "required": [ "watchId", "licenseType" ], "additionalProperties": false, "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}$" }, "licenseType": { "title": "License type code", "type": "string", "description": "DORA's short license type code, e.g. \"RN\", \"COS\", \"T-OT\" (uppercase letters, digits and hyphens, up to 10 characters — case-insensitive on input).", "pattern": "^[A-Za-z0-9-]{1,10}$" } } }, "default": [ { "watchId": "podiatry", "licenseType": "POD" } ] }, "notifyOn": { "title": "Send webhook", "enum": [ "new_alerts", "always", "never" ], "type": "string", "description": "new_alerts — post the webhook only when new billed 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) license 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 }, "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 } } } } } } } } } }