{ "openapi": "3.0.1", "info": { "title": "NPI Registry Exporter – Complete Provider Lists", "description": "Export complete lists of US doctors, dentists and other providers by specialty, state, city or ZIP from the CMS NPI Registry. Splits past the 1,200-record cap automatically and includes a completeness report. Pay per provider.", "version": "0.0", "x-build-id": "4g5JZjCi9DHI9HQan" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/classier_linear~npi-registry-exporter/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-classier_linear-npi-registry-exporter", "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/classier_linear~npi-registry-exporter/runs": { "post": { "operationId": "runs-sync-classier_linear-npi-registry-exporter", "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/classier_linear~npi-registry-exporter/run-sync": { "post": { "operationId": "run-sync-classier_linear-npi-registry-exporter", "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", "required": [ "state" ], "properties": { "taxonomyDescription": { "title": "Specialty (NUCC taxonomy description)", "type": "string", "description": "Provider specialty as written in the NUCC taxonomy, for example Dentist, Family Medicine, Nurse Practitioner, Physical Therapist, Chiropractor, Pharmacy. The registry matches this text inside ANY of a provider's taxonomy descriptions (primary or secondary), so 'Dentist' also returns 'Dentist, General Practice', 'Dentist, Pediatric Dentistry' and so on. Use the full description to narrow (for example 'Dentist, Orthodontics and Dentofacial Orthopedics'). Leave empty to export every provider type in the given cities or ZIP codes." }, "state": { "title": "State", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "PR", "VI", "GU", "AS", "MP" ], "type": "string", "description": "Two-letter code of the state or territory of the provider's PRACTICE LOCATION address. One state per run; run the Actor once per state for multi-state lists." }, "cities": { "title": "Cities (optional)", "type": "array", "description": "Practice-location cities, for example Kyle, Austin, San Antonio. Leave empty for the whole state. Matching is case-insensitive and uses the registry's own spelling (no punctuation).", "items": { "type": "string" } }, "postalCodes": { "title": "ZIP codes or ZIP prefixes (optional)", "type": "array", "description": "Practice-location ZIP codes (5 digits, for example 78640) or prefixes with a trailing * and at least two digits (for example 786*). Leave empty for the whole state. If both cities and ZIP codes are given, providers matching ANY of them are exported (merged, de-duplicated by NPI).", "items": { "type": "string" } }, "enumerationType": { "title": "Provider type", "enum": [ "ALL", "NPI-1", "NPI-2" ], "type": "string", "description": "NPI-1 = individual providers (doctors, dentists, nurses, therapists). NPI-2 = organizations (group practices, clinics, hospitals, pharmacies, suppliers).", "default": "ALL" }, "includeMailingAddress": { "title": "Include mailing address columns", "type": "boolean", "description": "Adds mailingAddress1, mailingAddress2, mailingCity, mailingState, mailingPostalCode and mailingPhone (often a billing office or PO box). The practice location address is always included.", "default": false }, "maxResults": { "title": "Maximum providers to export", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many unique providers. Your run's 'Maximum cost per run' also caps the export: at $2.50 per 1,000 providers a $1.00 cap allows 400 providers. Large state-wide specialties (for example all Texas dentists) need 20,000 or more.", "default": 1000 } } }, "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 } } } } } } } } } }