{
  "openapi": "3.0.1",
  "info": {
    "title": "Illinois IDFPR Professional License Scraper",
    "description": "Search and verify Illinois professional licenses from IDFPR - nurses, physicians, real estate, cosmetology, accountants, engineers, contractors, and 60+ other license types. Lookup by name, license number, license type, location, or disciplinary history.",
    "version": "1.0",
    "x-build-id": "faH24GbnlX15RXlfM"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/crawlerbros~illinois-idfpr-license-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~illinois-idfpr-license-scraper/runs": {
      "post": {
        "operationId": "runs-sync-crawlerbros-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/crawlerbros~illinois-idfpr-license-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-crawlerbros-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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "byLicenseNumbers",
              "disciplinaryActions"
            ],
            "type": "string",
            "description": "What to fetch.",
            "default": "search"
          },
          "lastName": {
            "title": "Last name (mode=search)",
            "type": "string",
            "description": "Licensee or business last name / prefix match, case-insensitive. e.g. `Smith`.",
            "default": "Smith"
          },
          "firstName": {
            "title": "First name (mode=search)",
            "type": "string",
            "description": "Licensee first name / prefix match, case-insensitive."
          },
          "businessName": {
            "title": "Business name (mode=search)",
            "type": "string",
            "description": "Business / entity name / prefix match, case-insensitive."
          },
          "keyword": {
            "title": "Keyword (full-text, mode=search)",
            "type": "string",
            "description": "Free-text search across all fields (name, business name, city, license description, etc). Use when you don't know which field to search."
          },
          "licenseNumbers": {
            "title": "License numbers (mode=byLicenseNumbers)",
            "type": "array",
            "description": "Exact IDFPR license numbers to look up, e.g. `225000009`.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "licenseType": {
            "title": "License type / profession board",
            "enum": [
              "",
              "ACUPUNCTURE",
              "ADULT USE CANNABIS BD",
              "ADVISORY BD OF BEHAV",
              "ADV PRACTICE NURSE",
              "APPRAISAL",
              "ARCHITECT",
              "ATHLETE AGENT",
              "ATHLETICS",
              "ATHLETIC TRAINER",
              "AUCTIONEER",
              "CEMETERY OVERSIGHT",
              "CLIN PSYCHOLOGIST",
              "COLLECTION AGENCY",
              "COMM ASSOC MGR",
              "COSMO",
              "DENTAL",
              "DESIGN FIRM",
              "DETECT. DECEPTION",
              "DETECTIVE BOARD",
              "DIETETIC AND NUTRITION",
              "ENVIRON. HLTH PRACT",
              "FUNERAL AND EMBALMER",
              "GEOLOGY",
              "HME AND SERVICES PROV",
              "HOME INSPECTOR",
              "IDPR",
              "INTERIOR DESIGN",
              "LANDSCAPE ARCHITECT",
              "LAND SURVEYOR BOARD",
              "LIMITED LIABILITY CO",
              "MAR AND FAM THERAPIST",
              "MASSAGE LICENSING BD",
              "MEDICAL BOARD",
              "MEDICAL CANNABIS BD",
              "MEDICAL CORP",
              "MIDWIFERY BOARD",
              "MUSIC THERAPY BOARD",
              "NAPRAPATHY",
              "NURSING BOARD",
              "NURSING HOME ADMIN",
              "OCCUPATIONAL THERAPY",
              "OPTOMETRY",
              "ORTHO,PROST.,PEDORTH",
              "PERFUSION",
              "PHARMACY",
              "PHYSICAL THERAPY",
              "PHYSICIAN ASSISTANT",
              "PODIATRY",
              "PROF. COUNSELOR",
              "PROF. ENGINEER",
              "PROF SERVICE CORP",
              "PUBLIC ACCOUNTANT",
              "REAL ESTATE",
              "RESPIRATORY CARE",
              "ROOFING CONTRACTOR",
              "SEX OFFENDER PROVIDER",
              "SHORTHAND REPORTER",
              "SOCIAL WORKER",
              "SPEECH-LANGUAGE PATH",
              "STRUCTURAL ENGINEER",
              "SURGICAL ASSIST-TECH",
              "TIME SHARE LAND SALES",
              "VETERINARY"
            ],
            "type": "string",
            "description": "Restrict results to one IDFPR license type / board. Leave as \"Any\" to search across all professions.",
            "default": ""
          },
          "licenseStatus": {
            "title": "License status",
            "enum": [
              "",
              "ACTIVE",
              "ACTIVE CHAPERONE REQUIRED",
              "CANCELLED",
              "CHANGE OF OWNERSHIP",
              "CLOSED",
              "DECEASED",
              "DECEASED CHAPERONE REQUIRED",
              "EXPIRED",
              "EXPIRED-RENEWABLE",
              "INACTIVE",
              "INOPERATIVE",
              "INSURANCE EXPIRED",
              "Non Sufficient Fund Check",
              "Non Sufficient Fund Check Terminated",
              "NOT RENEWED",
              "NOT RENEWED CHAPERONE REQUIRED",
              "PERMANENT INACTIVE",
              "PERMANENT INACTIVE CHAPERONE REQUIRED",
              "PROBATION",
              "REFUSE TO RENEW",
              "RELINQUISH",
              "RELINQUISH CHAPERONE REQUIRED",
              "REVOKED",
              "REVOKED CHAPERONE REQUIRED",
              "SUSPENDED",
              "SUSPENDED CHAPERONE REQUIRED",
              "TERMINATED",
              "TERMINATED CARD RETURNED",
              "TERMINATED VALID REASON",
              "TERMINATED WITHOUT CARD",
              "VOLUNTARY SURRENDER"
            ],
            "type": "string",
            "description": "Restrict results to one license status. Leave as \"Any\" for all statuses.",
            "default": ""
          },
          "city": {
            "title": "City",
            "type": "string",
            "description": "Filter by licensee/business city (exact match, case-insensitive)."
          },
          "county": {
            "title": "County",
            "type": "string",
            "description": "Filter by Illinois county (exact match, case-insensitive). Out-of-state licensees may have their home state in this field instead."
          },
          "state": {
            "title": "State (2-letter)",
            "type": "string",
            "description": "Filter by the licensee's mailing-address state, e.g. `IL`. Illinois licenses many out-of-state practitioners."
          },
          "zipCode": {
            "title": "ZIP code",
            "type": "string",
            "description": "Filter by exact 5-digit ZIP code."
          },
          "description": {
            "title": "License sub-type / description",
            "type": "string",
            "description": "Filter by the specific license sub-type description IDFPR reports (prefix match, case-insensitive), e.g. `REGISTERED PROFESSIONAL NURSE` within license type `NURSING BOARD`, or `LICENSED BOXER` within `ATHLETICS`."
          },
          "disciplinedOnly": {
            "title": "Disciplined licenses only",
            "type": "boolean",
            "description": "Only return licenses that have ever been subject to disciplinary action (mode=search / mode=byLicenseNumbers).",
            "default": false
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Hard cap on emitted records.",
            "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}