{ "openapi": "3.0.1", "info": { "title": "NPI Registry Provider Lookup & Enrichment", "description": "Search and enrich US healthcare providers from the official public NPI Registry. Verified, de-noised results by name, organization, taxonomy, and location.", "version": "0.1", "x-build-id": "CZmrxDJ7HeBv3fa4t" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/technicaldost~npi-registry-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-technicaldost-npi-registry-enrichment", "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/technicaldost~npi-registry-enrichment/runs": { "post": { "operationId": "runs-sync-technicaldost-npi-registry-enrichment", "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/technicaldost~npi-registry-enrichment/run-sync": { "post": { "operationId": "run-sync-technicaldost-npi-registry-enrichment", "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": { "npiNumbers": { "title": "NPI numbers (exact lookup)", "uniqueItems": true, "type": "array", "description": "One or more 10-digit NPI numbers for exact lookup. If set, the search filters below are ignored.", "items": { "type": "string" } }, "lastName": { "title": "Last name", "type": "string", "description": "Provider last name (individuals). Results are verified to actually match this name." }, "firstName": { "title": "First name", "type": "string", "description": "Provider first name (individuals)." }, "organizationName": { "title": "Organization name", "type": "string", "description": "Organization / practice name (e.g. a hospital, clinic, pharmacy)." }, "taxonomy": { "title": "Taxonomy / specialty", "type": "string", "description": "Specialty description, e.g. \"Pharmacy\", \"Family Medicine\", \"Internal Medicine\"." }, "city": { "title": "City", "type": "string", "description": "Practice city to filter by." }, "state": { "title": "State (2-letter)", "type": "string", "description": "US state code, e.g. CA, TX, NY. Strongly recommended to narrow common names." }, "postalCode": { "title": "Postal code", "type": "string", "description": "Practice postal/ZIP code to filter by." }, "providerType": { "title": "Provider type", "enum": [ "any", "individual", "organization" ], "type": "string", "description": "Filter by individual providers, organizations, or both.", "default": "any" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum matching providers to return. Controls your cost.", "default": 100 }, "enrichContacts": { "title": "Enrich contacts (best-effort email)", "type": "boolean", "description": "If on, attempts to fetch a website (from registry endpoints) and extract a contact email. Best-effort; often empty since NPI rarely lists websites.", "default": false } } }, "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 } } } } } } } } } }