{ "openapi": "3.0.1", "info": { "title": "NPI Registry API: US Healthcare Organizations", "description": "Find US hospitals, clinics, pharmacies, labs and other healthcare organisations in the official CMS NPI Registry. Search by name, state, city, ZIP or taxonomy, or look up NPIs. Organisations only (NPI-2), clean B2B fields, no personal data. Built for lead gen and AI agents.", "version": "1.0", "x-build-id": "v1dC7XuRWWhFUge9x" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wooden_scanner_c1n~us-healthcare-organizations-npi/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wooden_scanner_c1n-us-healthcare-organizations-npi", "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/wooden_scanner_c1n~us-healthcare-organizations-npi/runs": { "post": { "operationId": "runs-sync-wooden_scanner_c1n-us-healthcare-organizations-npi", "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/wooden_scanner_c1n~us-healthcare-organizations-npi/run-sync": { "post": { "operationId": "run-sync-wooden_scanner_c1n-us-healthcare-organizations-npi", "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": { "organizationNames": { "title": "Organisation names", "type": "array", "description": "Names to search (legal name, DBA, former or other name all match). One per line. By default each name matches as 'starts with' (e.g. 'mayo' finds 'MAYO CLINIC').", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Two-letter US state codes, e.g. CA, NY, TX. A state cannot be the only filter: combine it with a name, city, ZIP or taxonomy.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "City names, e.g. Boston. Best combined with a state.", "items": { "type": "string" } }, "postalCodes": { "title": "ZIP codes", "type": "array", "description": "5 or 9 digit ZIP codes, or a prefix with a trailing * (at least 2 digits, e.g. 021*).", "items": { "type": "string" } }, "taxonomyDescriptions": { "title": "Taxonomy (specialty / organisation type)", "type": "array", "description": "NUCC taxonomy descriptions, e.g. 'General Acute Care Hospital', 'Pharmacy', 'Clinic/Center', 'Home Health', 'Skilled Nursing Facility', 'Ambulatory Surgical', 'Clinical Medical Laboratory'.", "items": { "type": "string" } }, "npiNumbers": { "title": "NPI numbers", "type": "array", "description": "Look up specific 10-digit NPIs. Individual-provider NPIs (Type 1) are skipped: only organisations are returned.", "items": { "type": "string" } }, "maxItems": { "title": "Max organisations", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of organisation records to return across all searches. You pay per record.", "default": 100 }, "addressPurpose": { "title": "Which address to match", "enum": [ "ANY", "LOCATION", "PRIMARY", "SECONDARY", "MAILING" ], "type": "string", "description": "Apply state / city / ZIP filters to any address (default), practice locations, the primary practice location only, secondary locations only, or the mailing address.", "default": "ANY" }, "namePrefixMatch": { "title": "Match names as 'starts with'", "type": "boolean", "description": "On: 'mayo' finds every organisation whose name starts with MAYO. Off: exact name match only (you can still add * yourself).", "default": true }, "autoSplit": { "title": "Split big searches automatically", "type": "boolean", "description": "The NPI Registry API can page through at most 1,200 matches per search. When a search has more and you asked for more, it is split by ZIP-code prefix so you can get past that ceiling.", "default": true }, "includeDeactivated": { "title": "Include deactivated NPIs", "type": "boolean", "description": "Off by default. When on, deactivated NPIs are returned with NPI and status only, as CMS asks.", "default": false } } }, "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 } } } } } } } } } }