{ "openapi": "3.0.1", "info": { "title": "NPPES Healthcare Organization Change Monitor", "description": "Track new and reactivated healthcare organization NPIs from official CMS NPPES weekly data. Filter by state or taxonomy, or monitor up to 100 NPIs.", "version": "0.0", "x-build-id": "T7E226v5VKUr7Vexo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/theleadforge~nppes-healthcare-organization-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-theleadforge-nppes-healthcare-organization-change-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/theleadforge~nppes-healthcare-organization-change-monitor/runs": { "post": { "operationId": "runs-sync-theleadforge-nppes-healthcare-organization-change-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/theleadforge~nppes-healthcare-organization-change-monitor/run-sync": { "post": { "operationId": "run-sync-theleadforge-nppes-healthcare-organization-change-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", "required": [ "mode", "preview", "maxEvents" ], "properties": { "mode": { "title": "Mode", "enum": [ "weeklyFeed", "watchlist" ], "type": "string", "description": "Use Weekly feed for nationwide/state/taxonomy signals, or Watchlist for up to 100 known organization NPIs.", "default": "weeklyFeed" }, "preview": { "title": "Free 10-record preview", "type": "boolean", "description": "Returns the same deterministic 10 nationwide records for the current weekly release. Preview runs do not use replay state and are not charged.", "default": true }, "monitorId": { "title": "Monitor ID (paid modes)", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "minLength": 1, "maxLength": 64, "type": "string", "description": "Stable ID used to preserve replay state across scheduled runs, for example my-national-feed or hospital-watchlist." }, "states": { "title": "US state filters (weekly feed only)", "maxItems": 64, "uniqueItems": true, "type": "array", "description": "Optional two-letter state or territory codes. Leave empty for nationwide results.", "items": { "type": "string", "pattern": "^[A-Za-z]{2}$" }, "default": [] }, "taxonomyCodes": { "title": "Taxonomy code filters (weekly feed only)", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Optional exact NUCC healthcare provider taxonomy codes.", "items": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$" }, "default": [] }, "eventTypes": { "title": "Event types (paid modes)", "minItems": 1, "maxItems": 3, "uniqueItems": true, "type": "array", "description": "Weekly feed supports enumerated and reactivated. Watchlist additionally supports qualified deactivations.", "items": { "type": "string", "enum": [ "organization_npi_enumerated", "organization_npi_reactivated", "organization_npi_deactivated" ], "enumTitles": [ "Organization NPI enumerated", "Organization NPI reactivated", "Organization NPI deactivated (watchlist only)" ] }, "default": [ "organization_npi_enumerated", "organization_npi_reactivated" ] }, "watchlistNpis": { "title": "Organization NPIs (watchlist mode)", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "One to 100 valid 10-digit organization NPIs. New entries are verified with an exact official NPPES API lookup.", "items": { "type": "string", "pattern": "^\\d{10}$" }, "default": [] }, "maxEvents": { "title": "Maximum delivered events (paid modes)", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Safety limit for visible validated output. The hard ceiling is 25,000 events per run.", "default": 25 } } }, "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 } } }, "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 } } } } } } } } } }