{ "openapi": "3.0.1", "info": { "title": "NPI Registry Provider Leads (No 1,200 Cap)", "description": "Search the official CMS NPI Registry for doctors, dentists, clinics, home health agencies and any provider type, with no 1,200-result cap. Phones, addresses, taxonomies, licenses, authorized officials. Auto-splits big searches by ZIP and dedupes.", "version": "1.0", "x-build-id": "W3ES5xJMnGqklTBdV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/open-data-tools-hq~npi-provider-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-open-data-tools-hq-npi-provider-leads", "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/open-data-tools-hq~npi-provider-leads/runs": { "post": { "operationId": "runs-sync-open-data-tools-hq-npi-provider-leads", "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/open-data-tools-hq~npi-provider-leads/run-sync": { "post": { "operationId": "run-sync-open-data-tools-hq-npi-provider-leads", "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": "Provider types (taxonomy)", "type": "array", "description": "NPI taxonomy descriptions, partial match, e.g. 'Dentist', 'Chiropractor', 'Physical Therapist', 'Home Health', 'Nurse Practitioner', 'Family Medicine', 'Pharmacy'. Each is searched separately.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Two-letter state codes. Each is searched separately.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Optional city names (exact).", "items": { "type": "string" } }, "postalCodes": { "title": "ZIP codes", "type": "array", "description": "Optional 5-digit ZIPs or prefixes with *, e.g. 941*.", "items": { "type": "string" } }, "enumerationType": { "title": "Provider entity type", "enum": [ "any", "individual", "organization" ], "type": "string", "description": "Individuals are people; organizations are clinics, agencies, groups, and pharmacies.", "default": "any" }, "firstName": { "title": "First name", "type": "string", "description": "Optional. Supports trailing * wildcard (2+ chars)." }, "lastName": { "title": "Last name", "type": "string", "description": "Optional. Supports trailing * wildcard (2+ chars)." }, "organizationName": { "title": "Organization name", "type": "string", "description": "Optional. Supports trailing * wildcard (2+ chars)." }, "practiceLocationStateOnly": { "title": "Practice location must be in selected states", "type": "boolean", "description": "The registry matches a state on any address (including mailing). Keep only providers whose practice location is in your states.", "default": true }, "primaryTaxonomyOnly": { "title": "Primary taxonomy must match", "type": "boolean", "description": "Keep only providers whose primary specialty matches the searched taxonomy.", "default": false }, "requirePhone": { "title": "Must have practice phone", "type": "boolean", "description": "Skip providers without a practice-location phone.", "default": false }, "enumeratedAfter": { "title": "NPI issued on/after (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Keep only providers whose NPI was issued on or after this date (new practices). Applied after search." }, "onlyNewSinceLastRun": { "title": "Monitor mode: only new since last run", "type": "boolean", "description": "Remember delivered NPIs and skip them next time.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many providers. You are charged only for providers returned.", "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 } } } } } } } } } }