{ "openapi": "3.0.1", "info": { "title": "Illinois License Scraper | IDFPR 1.2M+ Records", "description": "Extract 1.2M+ Illinois professional license records from IDFPR Socrata database. Pharmacy, nursing, physician, real estate & 100+ categories with discipline history & controlled substance data.", "version": "0.0", "x-build-id": "EOkwMYIV9Uu1FWAm4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~illinois-idfpr-license-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-illinois-idfpr-license-scraper", "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/haketa~illinois-idfpr-license-scraper/runs": { "post": { "operationId": "runs-sync-haketa-illinois-idfpr-license-scraper", "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/haketa~illinois-idfpr-license-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-illinois-idfpr-license-scraper", "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": { "licenseTypes": { "title": "License Types", "type": "array", "description": "Filter by license type. Examples: 'PHARMACY', 'NURSE', 'PHYSICIAN', 'DENTIST', 'REAL ESTATE', 'ARCHITECT', 'CPA', 'COSMETOLOGY', 'ATTORNEY'. Leave empty for all types. Case-insensitive.", "items": { "type": "string" } }, "descriptions": { "title": "License Descriptions (optional)", "type": "array", "description": "Filter by specific description within a license type. Examples: 'PHARMACIST', 'REGISTERED NURSE', 'PHARMACY TECHNICIAN'. Leave empty for all descriptions.", "items": { "type": "string" } }, "statusFilter": { "title": "Status Filter", "enum": [ "all", "active_only", "inactive_only" ], "type": "string", "description": "'all' returns every status. 'active_only' returns ACTIVE licenses. 'inactive_only' returns NOT RENEWED, EXPIRED, REVOKED, SUSPENDED etc.", "default": "all" }, "counties": { "title": "Counties (optional)", "type": "array", "description": "Filter by Illinois county. Examples: 'COOK', 'DUPAGE', 'LAKE', 'WILL', 'KANE', 'MCHENRY', 'WINNEBAGO', 'PEORIA', 'CHAMPAIGN', 'SANGAMON'. Case-insensitive.", "items": { "type": "string" } }, "cities": { "title": "Cities (optional)", "type": "array", "description": "Filter by city. Examples: 'CHICAGO', 'AURORA', 'NAPERVILLE', 'SPRINGFIELD', 'PEORIA', 'ROCKFORD'. Case-insensitive.", "items": { "type": "string" } }, "disciplineFilter": { "title": "Discipline Filter", "enum": [ "all", "clean_only", "disciplined_only" ], "type": "string", "description": "'all' = no filter, 'clean_only' = Ever Disciplined = N, 'disciplined_only' = Ever Disciplined = Y.", "default": "all" }, "issuedAfter": { "title": "Issued After Date (optional)", "type": "string", "description": "Only return licenses originally issued after this date. Format: YYYY-MM-DD. Leave empty for all dates." }, "maxRecords": { "title": "Max Records", "minimum": 0, "type": "integer", "description": "Maximum total records to output. Set 0 for unlimited. Full dataset is 1.2M+ records.", "default": 0 }, "pageSize": { "title": "Page Size", "minimum": 100, "maximum": 50000, "type": "integer", "description": "Records per Socrata API call. Max 50000. Higher = fewer requests but more memory.", "default": 1000 }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Delay between API requests in milliseconds. Socrata has generous limits but keep above 200ms.", "default": 300 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy settings. Usually not needed — Socrata API is public with generous rate limits." } } }, "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 } } } } } } } } } }