{ "openapi": "3.0.1", "info": { "title": "NPI Registry Scraper: US Doctor, Dentist & Clinic Leads", "description": "Find US healthcare providers from the official CMS NPI Registry: doctors, dentists, therapists, clinics and pharmacies with specialty, phone, fax, address and license. Filter by specialty, city, state or ZIP; catch newly registered practices; monitor only new NPIs.", "version": "1.0", "x-build-id": "1Cfby0ar9gSMg8Uul" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hydrocore~npi-healthcare-providers/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hydrocore-npi-healthcare-providers", "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/hydrocore~npi-healthcare-providers/runs": { "post": { "operationId": "runs-sync-hydrocore-npi-healthcare-providers", "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/hydrocore~npi-healthcare-providers/run-sync": { "post": { "operationId": "run-sync-hydrocore-npi-healthcare-providers", "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": { "specialties": { "title": "Specialties (taxonomy)", "type": "array", "description": "NPI taxonomy descriptions, e.g. Dentist, Family Medicine, Chiropractor, Physical Therapist, Nurse Practitioner, Pharmacy, Psychologist, Optometrist. Each is searched separately.", "default": [ "Dentist" ], "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Practice-location cities. Combine with States to avoid same-name cities.", "items": { "type": "string" } }, "states": { "title": "States (2-letter)", "type": "array", "description": "e.g. TX, CA. The NPI API needs at least one more criterion (specialty, city, ZIP or name) with a state.", "items": { "type": "string" } }, "postalCodes": { "title": "ZIP codes", "type": "array", "description": "5-digit ZIPs (or prefixes like 787*). Overrides cities. Use ZIPs to split big searches past the 1,200-per-query API limit.", "items": { "type": "string" } }, "providerType": { "title": "Provider type", "enum": [ "all", "individual", "organization" ], "type": "string", "description": "Default: both.", "default": "all" }, "organizationName": { "title": "Organization name (optional)", "type": "string", "description": "Trailing * wildcard allowed, e.g. 'smile*'." }, "lastName": { "title": "Last name (optional)", "type": "string", "description": "Individuals only. Trailing * wildcard allowed." }, "firstName": { "title": "First name (optional)", "type": "string", "description": "Individuals only." }, "npiNumbers": { "title": "Look up NPI numbers", "type": "array", "description": "10-digit NPIs to enrich/verify. When set, other search fields are ignored.", "items": { "type": "string" } }, "enumeratedWithinDays": { "title": "Newly registered: NPI issued in the last N days", "minimum": 1, "type": "integer", "description": "Find new practices and newly licensed providers. Empty = any date." }, "updatedWithinDays": { "title": "Record updated in the last N days", "minimum": 1, "type": "integer", "description": "Catch moves, new addresses and phone changes. Empty = any date." }, "onlyPrimarySpecialty": { "title": "Primary specialty must match", "type": "boolean", "description": "Drop providers where your specialty is only a secondary taxonomy.", "default": false }, "requirePhone": { "title": "Only rows with a phone number", "type": "boolean", "description": "Skip providers without a practice phone.", "default": false }, "autoSplit": { "title": "Auto-split big searches by ZIP", "type": "boolean", "description": "The NPI API returns at most 1,200 records per query. When a city/state search hits that limit, the Actor re-queries each ZIP code it found to reach the rest. On by default.", "default": true }, "sortBy": { "title": "Sort by", "enum": [ "newest", "recentlyUpdated", "name", "city" ], "type": "string", "description": "Applied before the cap.", "default": "newest" }, "maxResults": { "title": "Max providers", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap on saved (and charged) providers. Default 100.", "default": 100 }, "onlyNew": { "title": "Only providers not seen in earlier runs (monitor)", "type": "boolean", "description": "Remembers NPIs already saved and skips them next time.", "default": false }, "monitorKey": { "title": "Monitor name", "type": "string", "description": "Separate 'seen' lists for different saved searches.", "default": "default" } } }, "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 } } } } } } } } } }