{ "openapi": "3.0.1", "info": { "title": "NPI Registry lookup - healthcare providers (NPPES API)", "description": "Healthcare providers from the CMS NPI Registry (NPPES API 2.1): look up NPI numbers or search by taxonomy, name, organization, city, state, ZIP and NPI type. One flat row per provider: name, credential, primary taxonomy and license, practice and mailing address, phone, dates, status.", "version": "0.1", "x-build-id": "voGj60b2hJe2yubsN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/retrainmap~npi-provider-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-retrainmap-npi-provider-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/retrainmap~npi-provider-registry/runs": { "post": { "operationId": "runs-sync-retrainmap-npi-provider-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/retrainmap~npi-provider-registry/run-sync": { "post": { "operationId": "run-sync-retrainmap-npi-provider-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": { "npi_numbers": { "title": "NPI numbers (lookup mode)", "uniqueItems": true, "type": "array", "description": "Ten-digit NPI numbers to look up, one request each. When this list is non-empty the search criteria below are ignored. Numbers that fail the NPI check digit stop the run; numbers that are valid but unknown to the registry are listed in the run summary as not_found.", "items": { "type": "string" } }, "taxonomy_description": { "title": "Taxonomy (specialty) description", "type": "string", "description": "Healthcare Provider Taxonomy description, e.g. Physical Therapist, Family Medicine, Dentist, Pharmacy. Exact or with a trailing * wildcard (e.g. Physical Ther*). Matches any of the provider's taxonomies, not only the primary one." }, "first_name": { "title": "First name (individuals)", "type": "string", "description": "Provider first name; trailing * wildcard allowed after two characters." }, "last_name": { "title": "Last name (individuals)", "type": "string", "description": "Provider last name; trailing * wildcard allowed after two characters." }, "organization_name": { "title": "Organization name (organizations)", "type": "string", "description": "Organization legal or other name; trailing * wildcard allowed after two characters." }, "city": { "title": "City", "type": "string", "description": "City of the practice location or mailing address." }, "state": { "title": "State", "type": "string", "description": "Two-letter state or territory code (NC, TX, PR). The registry refuses a search by state alone - combine it with at least one other criterion." }, "postal_code": { "title": "Postal code", "type": "string", "description": "Five- or nine-digit ZIP; a trailing * wildcard is allowed after two characters (e.g. 276*)." }, "enumeration_type": { "title": "NPI type", "enum": [ "any", "NPI-1", "NPI-2" ], "type": "string", "description": "NPI-1 = individual provider, NPI-2 = organization. The registry requires at least one other criterion together with the type.", "default": "any" }, "max_records": { "title": "Maximum records", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stop after this many provider rows. Searches are capped at 1,200 results by CMS whatever you enter here (limit 200 per request, skip clamped at 1,000); lookups by number are limited only by this value.", "default": 200 }, "request_interval_ms": { "title": "Minimum interval between requests (ms)", "minimum": 250, "maximum": 10000, "type": "integer", "description": "Politeness delay towards npiregistry.cms.hhs.gov. Default 500 ms; the floor is 250 ms.", "default": 500 }, "contact_email": { "title": "Contact e-mail (From: header)", "type": "string", "description": "Sent in the standard From: request header next to the Actor's User-Agent so the data owner can reach the operator (RFC 9110 s10.1.2).", "default": "info@steelyardclinical.com" } } }, "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 } } } } } } } } } }