{ "openapi": "3.0.1", "info": { "title": "TX Nursing Licenses - RN, LVN & APRN Register", "description": "Texas Board of Nursing licenses (public open data): live RN directory (~436k, deep employment/specialty/degree fields), every RN ever issued (~794k), LVN/VN (~318k), advanced practice (~81k). Verify licenses, screen board action, or profile the workforce.", "version": "0.0", "x-build-id": "cqIOdIRgpqIZphXGA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~tx-bon-licenses/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-tx-bon-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~tx-bon-licenses/runs": { "post": { "operationId": "runs-sync-j0401-tx-bon-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~tx-bon-licenses/run-sync": { "post": { "operationId": "run-sync-j0401-tx-bon-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": { "type": { "title": "Register", "enum": [ "rn", "rn-history", "vn", "aprn" ], "type": "string", "description": "Which BON dataset to query. rn = the currently-registered RN directory (~436k) with the deep employment / practice / specialty / degree fields. rn-history = every RN license number ever issued (~794k, shallow fields). vn = every LVN/VN license (~318k). aprn = advanced-practice recognitions (~81k, NP/CRNA/CNM/CNS incl. prescriptive authority).", "default": "rn" }, "licenseNumber": { "title": "License number", "type": "string", "description": "Exact license number, e.g. 1000005. Returns that nurse's record (all of their rows in the chosen register)." }, "name": { "title": "Name", "type": "string", "description": "Nurse's last or first name (substring, case-insensitive). E.g. 'Johnson' or 'Allen'." }, "lastName": { "title": "Last name", "type": "string", "description": "Nurse's last name (substring)." }, "firstName": { "title": "First name", "type": "string", "description": "Nurse's first name (substring)." }, "status": { "title": "Status", "type": "string", "description": "License status. Blank on the rn register = CURRENT (the ~436k live RN directory). Blank on the other registers = the full register. Accepted values: CURRENT / ACTIVE, DELINQUENT, INACTIVE, DECEASED, REVOKED, SUSPENDED, VOL SURRENDER, VOLUNTEER RETIRED, RETIRED. For aprn the statuses are bare words (CURRENT / DELINQUENT / INACTIVE ...). Matches the official value exactly.", "default": "" }, "county": { "title": "County of residence", "type": "string", "description": "County of residence (substring). Available on rn / vn / aprn registers, e.g. 'HARRIS', 'Bexar'. Populated on ~90% of rn rows." }, "stateOfOriginalLicensure": { "title": "State of original licensure", "type": "string", "description": "Two-letter state where the nurse first licensed (e.g. 'TX', 'CA', 'FL')." }, "gender": { "title": "Gender", "enum": [ "", "F", "M" ], "type": "string", "description": "Gender: F or M (blank = both).", "default": "" }, "boardAction": { "title": "Board action", "enum": [ "", "Yes", "No" ], "type": "string", "description": "Only licenses with (or without) a current board action against them. Yes = disciplinary action on record. Screening flag for verification.", "default": "" }, "aggregate": { "title": "Aggregate instead of records", "type": "boolean", "description": "When on, returns one summary record per group (see groupBy) with license count and share - instead of individual nurses.", "default": false }, "groupBy": { "title": "Aggregate by", "enum": [ "", "employmentStatus", "status", "practiceSetting", "specialty", "highestDegree", "county", "gender", "stateOfOriginalLicensure", "apnCategory", "rxStatus" ], "type": "string", "description": "Which dimension to aggregate over. Blank = employmentStatus for rn, status otherwise. For rn: employmentStatus (full-time/part-time/...), practiceSetting, specialty, highestDegree, county, status. For vn / rn-history: status, county, gender. For aprn: apnCategory (NP/CRNA/CNM/CNS), rxStatus (prescriptive authority), county, status.", "default": "" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of records pushed (0 = up to ~10k per run; each record is metered individually, so there is no per-run charge cap). An aggregate over a register has at most a few hundred groups.", "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 } } } } } } } } } }