{ "openapi": "3.0.1", "info": { "title": "CO Professional Licenses - Nurses, MDs, Engineers", "description": "Colorado professional and occupational licenses (public open data, 1.6M records, 40+ license types): the state's register of licensed nurses, physicians, engineers, CPAs and more - licensee, license number, status, first-issued / last-renewed / expiration dates, specialty and discipline.", "version": "0.0", "x-build-id": "4DvtttmCpHvDHmTPh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~co-professional-licenses/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-co-professional-licenses", "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/j0401~co-professional-licenses/runs": { "post": { "operationId": "runs-sync-j0401-co-professional-licenses", "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/j0401~co-professional-licenses/run-sync": { "post": { "operationId": "run-sync-j0401-co-professional-licenses", "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": { "mode": { "title": "Mode", "enum": [ "rows", "aggregate" ], "type": "string", "description": "rows = license records matching your filters (default). aggregate = one count row per group (see groupBy).", "default": "rows" }, "licenseNumber": { "title": "License number", "type": "string", "description": "Exact license number. A number can appear on more than one row (an entity license plus its endorsements).", "default": "" }, "name": { "title": "Licensee name", "type": "string", "description": "Person first / last name or entity name substring. Blank = any.", "default": "" }, "licenseType": { "title": "License type", "type": "string", "description": "License type prefix (exact, 313 types in the register): RN (238,749), NA, APE, COS, DR (physician), PE (engineer), PN, AP, CPA, JW, EC (electrician), ... Blank = any.", "default": "" }, "status": { "title": "License status", "type": "string", "description": "Exact status (23 values, case-insensitive): Active, Active - With Conditions, Expired, Cancelled, Revoked, Surrendered, Suspended, Retired, Beyond 6 Years Expired, Grad to Higher Level, Need Master Hire - Cannot Practice, ... Active ~605,876; Expired ~912,462. Blank = any.", "default": "" }, "specialty": { "title": "Specialty", "type": "string", "description": "Specialty substring. Blank = any.", "default": "" }, "city": { "title": "City", "type": "string", "description": "City substring. Blank = any.", "default": "" }, "state": { "title": "State", "type": "string", "description": "Two-letter state. Blank = any.", "default": "" }, "zip": { "title": "Zip", "type": "string", "description": "Zip code (prefix match). Blank = any.", "default": "" }, "issuedFrom": { "title": "First issued on or after", "type": "string", "description": "Only licenses first issued on/after this date (YYYY-MM-DD).", "default": "" }, "issuedTo": { "title": "First issued before", "type": "string", "description": "Only licenses first issued before this date (YYYY-MM-DD).", "default": "" }, "expiresFrom": { "title": "Expires on or after", "type": "string", "description": "Only licenses expiring on/after this date (YYYY-MM-DD). Combine with status=Active for the current roster.", "default": "" }, "expiresTo": { "title": "Expires before", "type": "string", "description": "Only licenses expiring before this date (YYYY-MM-DD).", "default": "" }, "groupBy": { "title": "Aggregate by", "enum": [ "licenseType", "status", "state", "specialty" ], "type": "string", "description": "Which dimension to aggregate over. city is a filter, not a rollup (too many distinct values).", "default": "licenseType" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of records pushed in rows mode (0 = up to ~10k per run; each record is metered individually, so there is no per-run charge cap). Aggregate mode returns every group.", "default": 50 } } }, "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 } } } } } } } } } }