{ "openapi": "3.0.1", "info": { "title": "NPI Registry API & US Healthcare Provider Leads", "description": "Search the official NPI Registry of CMS by specialty, state, city or ZIP code: doctors, dentists, clinics and pharmacies with practice phone, fax, address, license and authorized official. Find new practices by NPI issue date.", "version": "1.0", "x-build-id": "Um32SzlLPArcLU112" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/digital_influx~us-healthcare-providers/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-digital_influx-us-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/digital_influx~us-healthcare-providers/runs": { "post": { "operationId": "runs-sync-digital_influx-us-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/digital_influx~us-healthcare-providers/run-sync": { "post": { "operationId": "run-sync-digital_influx-us-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": { "taxonomies": { "title": "Specialties", "type": "array", "description": "Provider taxonomy descriptions, e.g. Dentist, Chiropractor, Physical Therapist, Nurse Practitioner, Family Medicine, Pharmacy, Home Health. A trailing * after 2 letters works as a wildcard (Ortho*). Each specialty is searched in each place.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "2-letter codes, e.g. TX, CA, FL. Each state is a search of its own.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "City and state, e.g. Austin, TX. Without the state, the city is searched in every state.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "5-digit ZIP codes, or their first 2 to 4 digits for a wider area (e.g. 787 for Austin).", "items": { "type": "string" } }, "providerType": { "title": "Provider type", "enum": [ "any", "organization", "individual" ], "type": "string", "description": "Organizations are practices, clinics, groups and pharmacies (NPI type 2); individuals are practitioners (NPI type 1).", "default": "any" }, "enumeratedWithinDays": { "title": "New providers: NPI issued within (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Keep only providers whose NPI was issued in the last N days: new practices and newly licensed practitioners. The registry has no date filter, so the whole search is read; a state takes a few minutes." }, "primaryOnly": { "title": "Only when it is the primary specialty", "type": "boolean", "description": "The registry matches any of a provider's specialties. This keeps those whose primary specialty contains the words searched.", "default": false }, "onlyWithPhone": { "title": "Only providers with a practice phone", "type": "boolean", "description": "Save only providers that list a practice location phone.", "default": false }, "npiNumbers": { "title": "NPI numbers to look up", "type": "array", "description": "10-digit NPI numbers to verify or enrich, one request each. Numbers with a wrong check digit are reported as invalid.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Providers saved in this run, newest NPI first. You also never pay more than the spending limit you set for the run.", "default": 1000 }, "onlyNew": { "title": "Only new or updated providers (for scheduled runs)", "type": "boolean", "description": "Save only providers that earlier runs of this same search did not save, or whose practice phone, address, primary specialty or status changed since (each row says which). Schedule it weekly. The memory lives in a key-value store named \"us-healthcare-providers-state\" in your account.", "default": false }, "memoryName": { "title": "Memory name (optional)", "type": "string", "description": "By default each search has its own memory. Give a name to share one memory between tasks, or a new name to start over." } } }, "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 } } } } } } } } } }