{ "openapi": "3.0.1", "info": { "title": "Virginia Nurse License Verification Scraper", "description": "Verify registered nurse, licensed practical nurse, advanced practice registered nurse, nurse aide, and nursing home administrator licenses issued by the Virginia Department of Health Professions (DHP) Board of Nursing. Search by name or look up an exact license number.", "version": "1.0", "x-build-id": "GfHhMjf0GUb2fauQ2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~virginia-nurse-license-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-virginia-nurse-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~virginia-nurse-license-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-virginia-nurse-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~virginia-nurse-license-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-virginia-nurse-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", "byLicenseNumber" ], "type": "string", "description": "What to search.", "default": "search" }, "lastName": { "title": "Last name", "type": "string", "description": "(mode=search) Licensee last name. Required unless zipCode is given.", "default": "Johnson" }, "firstName": { "title": "First name", "type": "string", "description": "(mode=search) Licensee first name. Optional, narrows results.", "default": "Mary" }, "zipCode": { "title": "ZIP code", "type": "string", "description": "(mode=search) Licensee mailing ZIP code. Required unless lastName is given." }, "occupation": { "title": "Occupation", "enum": [ "any", "1", "2", "24", "15", "17", "32", "33", "34", "1401", "1403", "31", "1701", "1732", "1703" ], "type": "string", "description": "(mode=search) Restrict the search to one Board of Nursing occupation type. Leave as \"Any\" to search across all nursing-related occupations (issues one request per occupation).", "default": "1" }, "occupations": { "title": "Occupation types (multi-select)", "type": "array", "description": "(mode=search) Search a specific custom subset of two or more Board of Nursing occupation types in one run (e.g. RN + LPN only, or Nurse Aide + Medication Aide only) -- issues one request per selected occupation. Overrides `occupation` when non-empty; leave empty to use the single `occupation` selection above.", "items": { "type": "string", "enum": [ "1", "2", "24", "15", "17", "32", "33", "34", "1401", "1403", "31", "1701", "1732", "1703" ], "enumTitles": [ "Registered Nurse (RN)", "Licensed Practical Nurse (LPN)", "Advanced Practice Registered Nurse (APRN)", "Clinical Nurse Specialist", "Authorization to Prescribe", "Registered Nurse Restricted Volunteer", "Licensed Practical Nurse Restricted Volunteer", "Licensed Nurse Practitioner Restricted Volunteer", "Nurse Aide (CNA)", "Advanced Certified Nurse Aide", "Medication Aide", "Nursing Home Administrator", "Nursing Home Administrator-In-Training", "Nursing Home Preceptor" ] }, "default": [] }, "addressState": { "title": "Mailing address state", "enum": [ "", "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "type": "string", "description": "(mode=search) Filter by the licensee's mailing address US state (licensees can live outside Virginia).", "default": "" }, "licenseStatus": { "title": "License status", "enum": [ "any", "current", "expired" ], "type": "string", "description": "(mode=search) Filter to current or expired licensees as recorded by DHP.", "default": "any" }, "statusContainsFilter": { "title": "Filter by license status text", "type": "string", "description": "Only emit records whose detail-page license status contains this text (case-insensitive), e.g. \"Active\", \"Suspended\", \"Revoked\", \"Probation\", \"Compact\". Applied client-side after fetching each record's detail page." }, "licenseNumbers": { "title": "License numbers", "type": "array", "description": "(mode=byLicenseNumber) One or more exact 10-digit Virginia DHP license numbers to verify directly.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 300, "type": "integer", "description": "Hard cap on emitted license records.", "default": 20 } } }, "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 } } } } } } } } } }