{ "openapi": "3.0.1", "info": { "title": "Illinois Professional Licenses - IDFPR Roster & Discipline", "description": "Illinois IDFPR's full professional licence register (public open data, 4.2M rows, 63 boards): licensee name, business, status and dates, plus the disciplinary case, action and written reason behind 103K disciplined licences.", "version": "0.0", "x-build-id": "xzkEFKddAAcfhnZjI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~il-professional-licenses/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-il-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~il-professional-licenses/runs": { "post": { "operationId": "runs-sync-j0401-il-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~il-professional-licenses/run-sync": { "post": { "operationId": "run-sync-j0401-il-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 = licence records matching your filters (default). aggregate = one count row per group.", "default": "rows" }, "groupBy": { "title": "Group by", "enum": [ "", "licenseType", "licenseStatus", "county", "state", "business", "everDisciplined" ], "type": "string", "description": "Aggregate dimension, only used when mode=aggregate.", "default": "licenseType" }, "licenseNumber": { "title": "Licence number", "type": "string", "description": "Exact licence number, e.g. '198000121'. Blank = any. Note the source masks some numbers (e.g. '33*****04') and leaves 38,555 blank.", "default": "" }, "name": { "title": "Name", "type": "string", "description": "Substring matching the licensee's last OR first name, e.g. 'SMITH'. Blank = any.", "default": "" }, "firstName": { "title": "First name", "type": "string", "description": "First-name substring. Blank = any.", "default": "" }, "lastName": { "title": "Last name", "type": "string", "description": "Last-name substring. Blank = any.", "default": "" }, "licenseType": { "title": "Board / licence type", "type": "string", "description": "Board-name substring, e.g. 'NURSING', 'REAL ESTATE', 'COSMO'. Blank = any. 63 boards in total.", "default": "" }, "licenseStatus": { "title": "Licence status", "enum": [ "", "NOT RENEWED", "ACTIVE", "INACTIVE", "EXPIRED", "CANCELLED", "TERMINATED CARD RETURNED", "DECEASED", "CLOSED", "TERMINATED", "REFUSE TO RENEW", "SUSPENDED", "CHANGE OF OWNERSHIP", "INOPERATIVE", "REVOKED", "TERMINATED WITHOUT CARD", "TERMINATED VALID REASON", "RELINQUISH", "PROBATION", "Non Sufficient Fund Check Terminated", "EXPIRED-RENEWABLE", "PERMANENT INACTIVE", "VOLUNTARY SURRENDER", "Non Sufficient Fund Check", "REVOKED CHAPERONE REQUIRED", "SUSPENDED CHAPERONE REQUIRED", "ACTIVE CHAPERONE REQUIRED", "INSURANCE EXPIRED", "PERMANENT INACTIVE CHAPERONE REQUIRED", "RELINQUISH CHAPERONE REQUIRED", "DECEASED CHAPERONE REQUIRED", "NOT RENEWED CHAPERONE REQUIRED" ], "type": "string", "description": "Exact licence status. Blank = any. Some values are a base status plus a CHAPERONE REQUIRED suffix - they are distinct statuses.", "default": "" }, "specialtyQualifier": { "title": "Specialty qualifier", "type": "string", "description": "Specialty-qualifier substring (e.g. a nursing or dental specialty). Blank = any.", "default": "" }, "businessName": { "title": "Business name", "type": "string", "description": "Business-name substring, e.g. a hospital or agency. Blank = any.", "default": "" }, "dba": { "title": "DBA", "type": "string", "description": "Business DBA substring. Blank = any.", "default": "" }, "business": { "title": "Business licence", "enum": [ "", "Y", "N" ], "type": "string", "description": "Y = a business/entity licence; N = a natural person. Blank = both.", "default": "" }, "everDisciplined": { "title": "Ever disciplined", "enum": [ "", "Y", "N" ], "type": "string", "description": "Y = this licence has at least one disciplinary case on record. Blank = both. Pair with licenseNumber to pull a full discipline history.", "default": "" }, "caseNumber": { "title": "Discipline case number", "type": "string", "description": "Exact disciplinary case number. Blank = any.", "default": "" }, "city": { "title": "City", "type": "string", "description": "City substring, e.g. 'CHICAGO'. Blank = any.", "default": "" }, "county": { "title": "County", "type": "string", "description": "County substring, e.g. 'COOK'. Blank = any.", "default": "" }, "state": { "title": "State", "type": "string", "description": "Two-letter state, e.g. 'IL'. Blank = any.", "default": "" }, "zip": { "title": "ZIP", "type": "string", "description": "ZIP prefix, e.g. '60615' or '606'. Blank = any.", "default": "" }, "expirationYear": { "title": "Expiry year", "type": "string", "description": "4-digit year: matches licences EXPIRING in that year, e.g. '2027'. Blank = any. The source stores dates as MM/DD/YYYY text, so filtering is year-granularity only. 2099 is the source's no-expiration sentinel and is rejected.", "default": "" }, "issuedYear": { "title": "Issue year", "type": "string", "description": "4-digit year: matches licences originally ISSUED in that year. Blank = any.", "default": "" }, "modifiedYear": { "title": "Last modified year", "type": "string", "description": "4-digit year: matches records last MODIFIED in that year - use it to pull a recent-change slice. Blank = any.", "default": "" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap records returned for this run. Default 50 keeps the daily auto-test fast. 0 = no cap (the full matching slice, up to 10,000).", "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 } } } } } } } } } }