{ "openapi": "3.0.1", "info": { "title": "NYSED Professional License Verification API", "description": "Verify any New York State licensed professional — physicians, nurses, PEs, CPAs, architects, dentists, pharmacists, and 110+ more — directly from NYSED. $0.005–$0.020 per record. Empty searches never charged.", "version": "0.0", "x-build-id": "bsSb4M6Ofkmj9OUx9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ws_tony~nysed-professional-license-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ws_tony-nysed-professional-license-search", "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/ws_tony~nysed-professional-license-search/runs": { "post": { "operationId": "runs-sync-ws_tony-nysed-professional-license-search", "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/ws_tony~nysed-professional-license-search/run-sync": { "post": { "operationId": "run-sync-ws_tony-nysed-professional-license-search", "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": { "licenseeNames": { "title": "Licensee name searches", "type": "array", "description": "List of name+professionCode pairs. `name` is a partial-match search (last or full name works well). `professionCode` is the 3-digit NYSED code — e.g. 060=Medicine (Physician), 016=Professional Engineer, 003=Architect, 007=Certified Public Accountant, 022=Registered Professional Nurse, 050=Dentist, 020=Pharmacist, 075=Veterinarian, 073=LCSW, 068=Psychologist, 062=Physical Therapist, 065=Podiatrist. Full list of 116 codes: https://api.nysed.gov/rosa/V2/licenseeProfessions. Use code `ALL` to search every profession at once.", "default": [] }, "licenseNumbers": { "title": "Direct license-number lookups", "type": "array", "description": "Direct lookups by (professionCode, licenseNumber). Skips the name-search step — one request = one record.", "default": [] }, "enrichmentLevel": { "title": "Enrichment level", "enum": [ "basic", "full" ], "type": "string", "description": "`basic` returns name, profession, license number, status, date of licensure, registered-through date, and city/state. `full` also pulls school of degree, degree date, additional qualifications, additional licenses, privileges, certificate of authorizations, and enforcement-action summaries.", "default": "basic" }, "maxResultsPerSearch": { "title": "Max results per search term", "minimum": 1, "maximum": 500, "type": "integer", "description": "Upper bound on records pushed per (name, professionCode) pair. NYSED paginates at 20 per page; the actor auto-pages up to this cap.", "default": 20 }, "requestTimeoutSecs": { "title": "Per-request timeout (seconds)", "minimum": 10, "maximum": 120, "type": "integer", "description": "HTTP timeout applied to each NYSED API call. Raise if you see timeout warnings in the log; 30 seconds is well above their typical sub-second response time.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy (datacenter group) is plenty for this actor — NYSED has no WAF or per-IP throttle that we've observed. Configurable here in case you want residential or your own pool.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }