{ "openapi": "3.0.1", "info": { "title": "NPI Registry Search - US Doctors & Healthcare Providers", "description": "Search the official NPPES NPI Registry for US doctors, dentists, nurses, clinics and hospitals by name, specialty (taxonomy), city, state or ZIP code, or look up NPI numbers. Returns clean rows with specialties, licenses, practice and mailing addresses and phone numbers. $2 per 1,000 providers.", "version": "1.0", "x-build-id": "K4BKLf2Jfa77ku9zi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kantolabs~npi-registry-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kantolabs-npi-registry-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/kantolabs~npi-registry-search/runs": { "post": { "operationId": "runs-sync-kantolabs-npi-registry-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/kantolabs~npi-registry-search/run-sync": { "post": { "operationId": "run-sync-kantolabs-npi-registry-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": { "taxonomies": { "title": "Specialties (taxonomy descriptions)", "type": "array", "description": "Provider specialties as written in the NUCC taxonomy, e.g. `Dentist`, `Cardiology`, `Family Medicine`, `Nurse Practitioner`, `Physical Therapist`, `Pharmacy`. Partial words match (`Family` finds Family Medicine and Nurse Practitioner, Family). One search is run per specialty and location.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Two-letter US state codes (`TX`, `NY`). The registry does not accept a state on its own - combine it with a specialty, name, city or ZIP code.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "City names (`Austin`). Combined with every state above.", "items": { "type": "string" } }, "postalCodes": { "title": "ZIP codes", "type": "array", "description": "5-digit ZIP codes (`78701`). When given, they are used instead of cities. Searching ZIP by ZIP is the way to collect more than 1,200 providers for one specialty in a big city.", "items": { "type": "string" } }, "firstName": { "title": "First name", "type": "string", "description": "Individual provider's first name. Add `*` after at least 2 letters for a prefix search (`Jo*`)." }, "lastName": { "title": "Last name", "type": "string", "description": "Individual provider's last name. `*` wildcard allowed after 2 letters." }, "organizationName": { "title": "Organization name", "type": "string", "description": "Clinic, hospital, pharmacy or group name, e.g. `Mayo*`. `*` wildcard allowed after 2 letters." }, "providerType": { "title": "Provider type", "enum": [ "any", "individual", "organization" ], "type": "string", "description": "Individuals (NPI-1: doctors, dentists, nurses...) or organizations (NPI-2: clinics, hospitals, pharmacies, groups).", "default": "any" }, "npiNumbers": { "title": "NPI numbers to look up", "type": "array", "description": "10-digit NPI numbers. Each is looked up directly (in addition to any search above). Use this to verify or refresh a list you already have.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max providers per search", "minimum": 1, "maximum": 1200, "type": "integer", "description": "Cap per specialty x location combination. The registry itself returns at most 1,200 records for one search (200 per page, 6 pages) - split by ZIP code to get more.", "default": 50 }, "maxResults": { "title": "Max providers in total", "minimum": 0, "type": "integer", "description": "Stop after this many unique providers across all searches. 0 = no limit.", "default": 0 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }