{ "openapi": "3.0.1", "info": { "title": "NPI Healthcare Organization Enrollment Monitor", "description": "New and changed healthcare organizations (NPI type 2: clinics, pharmacies, home health, DME suppliers, labs) from the official CMS NPPES NPI Registry, with taxonomy, practice address and phone. Organizations only. No API key; new-only monitor mode.", "version": "0.2", "x-build-id": "idZKOTebBwXLXR516" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/transparent_meteorite~npi-new-provider-enrollment-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-transparent_meteorite-npi-new-provider-enrollment-monitor", "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/transparent_meteorite~npi-new-provider-enrollment-monitor/runs": { "post": { "operationId": "runs-sync-transparent_meteorite-npi-new-provider-enrollment-monitor", "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/transparent_meteorite~npi-new-provider-enrollment-monitor/run-sync": { "post": { "operationId": "run-sync-transparent_meteorite-npi-new-provider-enrollment-monitor", "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": { "mode": { "title": "Mode", "enum": [ "newEnrollments", "changes", "search" ], "type": "string", "description": "New enrollments = organizations whose NPI was issued on or after the start date. Changes = any organization record updated since the start date (new enrollments are labelled). Search = plain registry search with no date filter.", "default": "newEnrollments" }, "states": { "title": "States", "type": "array", "description": "Two-letter US state or territory codes, e.g. MI, TX. Each state is scanned separately.", "default": [ "MI" ], "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Only organizations whose practice location is in these cities. Use together with a state.", "default": [], "items": { "type": "string" } }, "postalCodes": { "title": "ZIP codes or prefixes", "type": "array", "description": "5-digit ZIPs or prefixes of at least 2 digits (for example 482 for Detroit).", "default": [], "items": { "type": "string" } }, "specialties": { "title": "Taxonomy (specialty) text", "type": "array", "description": "NUCC taxonomy description, for example Pharmacy, Home Health, Durable Medical Equipment, Clinic/Center, Laboratory, Dentist. Each one is scanned separately; wildcards like Pharm* work.", "default": [], "items": { "type": "string" } }, "primarySpecialtyOnly": { "title": "Match primary taxonomy only", "type": "boolean", "description": "Keep an organization only when the chosen taxonomy is its primary one, not just one of several listed.", "default": true }, "organizationCategories": { "title": "Organization categories", "type": "array", "description": "Keep only these categories (derived from the primary taxonomy code). Leave empty for all.", "items": { "type": "string", "enum": [ "pharmacy", "dme_supplier", "home_health", "hospice", "laboratory", "hospital", "clinic_center", "group_practice", "nursing_facility", "residential_treatment", "ambulance_transport", "supplier", "agency", "managed_care", "practice" ], "enumTitles": [ "Pharmacy", "DME supplier", "Home health", "Hospice", "Laboratory", "Hospital", "Clinic / center", "Group practice", "Nursing facility", "Residential treatment", "Ambulance / transport", "Other supplier", "Other agency", "Managed care", "Other practice" ] }, "default": [] }, "organizationName": { "title": "Organization name (optional)", "type": "string", "description": "Legal or DBA name to match, at least 2 characters; trailing * works as a wildcard, e.g. Walgreen*.", "default": "" }, "npis": { "title": "Look up NPIs (optional)", "type": "array", "description": "Up to 200 10-digit NPI numbers to look up directly. Individual (type 1) NPIs are never returned.", "default": [], "items": { "type": "string" } }, "activeOnly": { "title": "Active organizations only", "type": "boolean", "description": "Skip deactivated NPI records.", "default": true }, "lookbackDays": { "title": "Look back (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Start date = today minus this many days. Ignored when you set a start date below.", "default": 7 }, "sinceDate": { "title": "Start date (optional)", "type": "string", "description": "YYYY-MM-DD. Overrides the look-back. Leave empty to use the look-back.", "default": "" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap on organizations delivered (and charged) this run. Start with 25.", "default": 25 }, "requirePhone": { "title": "Only organizations with a practice phone", "type": "boolean", "description": "Skip rows with no practice-location phone on record.", "default": false }, "skipSeen": { "title": "Skip organizations already delivered (monitor modes)", "type": "boolean", "description": "In the new-enrollment and changes modes, skip providers delivered in an earlier run unless their record changed since. Turn off to return everything again.", "default": true }, "maxApiRequests": { "title": "Max registry requests", "minimum": 5, "maximum": 5000, "type": "integer", "description": "Safety cap on calls to the NPI registry for this run. Wide areas need more; a run that hits the cap returns what it found and says so.", "default": 400 }, "maxRunSeconds": { "title": "Max run time (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "The run stops scanning after this long and delivers what it found.", "default": 600 }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Name of the key-value store remembering delivered providers. Change it to keep separate monitors.", "default": "npi-new-provider-enrollment-monitor-seen" } } }, "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 } } } } } } } } } }