{ "openapi": "3.0.1", "info": { "title": "NPI / NPPES Healthcare Provider Registry Lookup", "description": "Look up US healthcare providers and organizations in the official CMS NPI Registry (NPPES). Search by NPI number, name, organization, specialty/taxonomy, or location. Returns NPI number, status, name, specialty, and practice address.", "version": "0.1", "x-build-id": "GvYc7RiQoBiYvxZe9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bovi~npi-nppes-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bovi-npi-nppes-registry", "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/bovi~npi-nppes-registry/runs": { "post": { "operationId": "runs-sync-bovi-npi-nppes-registry", "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/bovi~npi-nppes-registry/run-sync": { "post": { "operationId": "run-sync-bovi-npi-nppes-registry", "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": { "npiNumber": { "title": "NPI number (exact)", "type": "string", "description": "Look up a single exact 10-digit National Provider Identifier. Overrides all other search fields when set." }, "firstName": { "title": "First name (individual provider)", "type": "string", "description": "Individual provider's first name. Supports a trailing wildcard (e.g. \"John*\"). Only matches NPI-1 (individual) records." }, "lastName": { "title": "Last name (individual provider)", "type": "string", "description": "Individual provider's last name. Supports a trailing wildcard (e.g. \"Smi*\"). Only matches NPI-1 (individual) records." }, "organizationName": { "title": "Organization name", "type": "string", "description": "Healthcare organization name (hospital, clinic, group practice). Supports a trailing wildcard (e.g. \"St Mary*\"). Only matches NPI-2 (organization) records." }, "taxonomyDescription": { "title": "Specialty / taxonomy", "type": "string", "description": "Provider specialty or taxonomy description (e.g. \"Cardiology\", \"Nurse Practitioner\", \"Pediatrics\"). Matches the NUCC taxonomy description text." }, "city": { "title": "City", "type": "string", "description": "Filter by practice-address city." }, "state": { "title": "State (2-letter code)", "type": "string", "description": "Filter by practice-address state (e.g. TX, CA, NY).", "default": "CA" }, "postalCode": { "title": "ZIP / postal code", "type": "string", "description": "Filter by practice-address ZIP code (5-digit or 5+4)." }, "enumerationType": { "title": "Provider type", "enum": [ "", "NPI-1", "NPI-2" ], "type": "string", "description": "NPI-1 = individual provider only. NPI-2 = organization only. Leave blank to search both.", "default": "" }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 1200, "type": "integer", "description": "Maximum number of provider/organization records to return. The NPPES API caps any single query at ~1,200 reachable rows (200 per page × 6 pages) — narrow the search (add a state or taxonomy filter) to go deeper.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy used to reach the API. The actor works out of the box — no proxy key or credentials of your own are required; this is just Apify's standard rotating exit.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }