{ "openapi": "3.0.1", "info": { "title": "NPI Registry Search – US Doctors & Healthcare Providers", "description": "Search the official CMS NPPES NPI Registry: doctors, dentists, therapists, clinics and pharmacies by specialty, state, city or ZIP, or look up NPIs in bulk. Practice address, phone, fax, taxonomy, license, authorized official. Beats the 1,200-result API cap. $1 per 1,000 providers.", "version": "0.1", "x-build-id": "LMche43BRTTP3YnPd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gazidev~npi-registry-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gazidev-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/gazidev~npi-registry-search/runs": { "post": { "operationId": "runs-sync-gazidev-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/gazidev~npi-registry-search/run-sync": { "post": { "operationId": "run-sync-gazidev-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 / taxonomies", "type": "array", "description": "Provider taxonomy descriptions as used by NPPES, e.g. Dentist, Family Medicine, Chiropractor, Physical Therapist, Nurse Practitioner, Pharmacy, Clinical Social Worker. Partial words work (\"Dent\" is not enough; use whole words). Each specialty is searched in every location below.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "2-letter US state codes (TX, CA, NY...). The registry needs one more criterion with a state: a specialty, city, ZIP or name.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Optional. Combined with every state above (Austin + TX).", "items": { "type": "string" } }, "postalCodes": { "title": "ZIP codes", "type": "array", "description": "Optional. 5-digit ZIP codes or a prefix with a trailing * (at least 2 digits), e.g. 787* for the Austin area.", "items": { "type": "string" } }, "providerType": { "title": "Provider type", "enum": [ "any", "individual", "organization" ], "type": "string", "description": "Individuals (NPI-1: doctors, dentists, therapists), organizations (NPI-2: clinics, hospitals, pharmacies) or both.", "default": "any" }, "primaryTaxonomyOnly": { "title": "Only providers whose PRIMARY specialty matches", "type": "boolean", "description": "The registry also matches secondary taxonomies. Turn on to keep only providers whose primary taxonomy contains your specialty text (filtered rows are not charged).", "default": false }, "firstName": { "title": "First name", "type": "string", "description": "Individual's first name. Trailing * wildcard allowed after 2 letters (Jo*)." }, "lastName": { "title": "Last name", "type": "string", "description": "Individual's last name. Trailing * wildcard allowed after 2 letters." }, "organizationName": { "title": "Organization name", "type": "string", "description": "Organization (NPI-2) name, e.g. \"Kaiser*\" or \"Smile Dental\"." }, "npiNumbers": { "title": "NPI numbers (bulk lookup)", "type": "array", "description": "10-digit NPIs to look up. Invalid numbers (bad check digit) and not-found NPIs are reported free of charge.", "items": { "type": "string" } }, "bulkNpis": { "title": "Paste many NPIs", "type": "string", "description": "Paste NPIs separated by new lines, commas or spaces (e.g. a column from a spreadsheet)." }, "maxResults": { "title": "Max providers", "minimum": 0, "type": "integer", "description": "Stop after this many providers. 0 = no limit.", "default": 100 }, "autoSplit": { "title": "Get past the 1,200-results limit (auto-split by ZIP prefix)", "type": "boolean", "description": "The NPI API returns at most 1,200 results per query. When a search hits that cap, the Actor automatically splits it into ZIP-code prefixes (and individuals vs organizations) to reach the rest.", "default": true }, "requestsPerSecond": { "title": "Requests per second", "minimum": 1, "maximum": 5, "type": "integer", "description": "Polite request rate to the public CMS API.", "default": 3 } } }, "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 } } } } } } } } } }