{ "openapi": "3.0.1", "info": { "title": "US Healthcare Provider & Clinic NPI Registry Lead Scraper", "description": "Scrape US healthcare providers, medical clinics, dental practices & physicians from the official CMS NPPES NPI Registry v2.1 with Authorized Officials, phones & licenses.", "version": "0.1", "x-build-id": "dNZJYqoxubBecBVvk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/informed_almandine_vzb~us-npi-healthcare-provider-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-informed_almandine_vzb-us-npi-healthcare-provider-scraper", "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/informed_almandine_vzb~us-npi-healthcare-provider-scraper/runs": { "post": { "operationId": "runs-sync-informed_almandine_vzb-us-npi-healthcare-provider-scraper", "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/informed_almandine_vzb~us-npi-healthcare-provider-scraper/run-sync": { "post": { "operationId": "run-sync-informed_almandine_vzb-us-npi-healthcare-provider-scraper", "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": "Medical specialties or taxonomy descriptions", "type": "array", "description": "Specialty or taxonomy descriptions to query across the CMS NPPES NPI Registry (e.g. 'Dentist', 'Cardiology', 'Dermatology', 'Physical Therapist', 'Family Medicine', 'Clinic', 'Optometrist').", "default": [ "Dentist", "Cardiology", "Dermatology", "Physical Therapist" ], "items": { "type": "string" } }, "states": { "title": "US State codes (2-letter)", "type": "array", "description": "Two-letter US state or territory codes (e.g. 'CA', 'NY', 'TX', 'FL', 'IL').", "default": [ "CA", "NY", "TX" ], "items": { "type": "string" } }, "city": { "title": "City filter (optional)", "type": "string", "description": "Optional city name filter (e.g. 'Los Angeles', 'New York', 'Houston').", "default": "" }, "postalCode": { "title": "ZIP / Postal code filter (optional)", "type": "string", "description": "Optional 5-digit ZIP code or prefix filter (e.g. '90210' or '902*').", "default": "" }, "enumerationType": { "title": "Provider entity type (NPI-2 Clinics vs NPI-1 Individuals)", "enum": [ "ALL", "NPI-2", "NPI-1" ], "type": "string", "description": "Filter to 'NPI-2' (Organizations, Clinics, Dental Practices & Labs — includes Authorized Official decision-maker name, title & phone), 'NPI-1' (Individual Physicians & Specialists), or 'ALL'.", "default": "ALL" }, "organizationName": { "title": "Organization / Clinic name search (optional)", "type": "string", "description": "Optional medical group, hospital, or clinic organization name filter.", "default": "" }, "onlyNew": { "title": "Only new NPI numbers", "type": "boolean", "description": "Deduplicate by 10-digit NPI number across runs via Apify Key-Value Store.", "default": false }, "maxResultsPerQuery": { "title": "Max results per specialty query", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of NPI provider/clinic records to emit per specialty taxonomy (default 4 taxonomies x 20 = 80 records).", "default": 20 }, "delaySeconds": { "title": "Delay between requests (seconds)", "minimum": 0, "type": "number", "description": "Polite pause between requests.", "default": 0.15 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }