{ "openapi": "3.0.1", "info": { "title": "Us Healthcare Npi Medical Practice Lead Enricher", "description": "Find US healthcare providers and organizations in the official NPPES NPI Registry. Filter by specialty and location, extract public practice contacts and authorized officials, and optionally enrich confirmed websites with emails and booking signals.", "version": "0.0", "x-build-id": "pqyWrboDi9Xi7Y9Ej" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arezdev~us-healthcare-npi-medical-practice-lead-enricher/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arezdev-us-healthcare-npi-medical-practice-lead-enricher", "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/arezdev~us-healthcare-npi-medical-practice-lead-enricher/runs": { "post": { "operationId": "runs-sync-arezdev-us-healthcare-npi-medical-practice-lead-enricher", "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/arezdev~us-healthcare-npi-medical-practice-lead-enricher/run-sync": { "post": { "operationId": "run-sync-arezdev-us-healthcare-npi-medical-practice-lead-enricher", "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": [ "taxonomyDescription", "state" ], "properties": { "taxonomyDescription": { "title": "Specialty or taxonomy description", "minLength": 2, "maxLength": 120, "type": "string", "description": "Official specialty description, such as Dentist, Physical Therapist, Clinical Medical Laboratory, or Clinic/Center. MedSpas have no single NPPES taxonomy; choose the relevant medical specialty.", "default": "Dentist" }, "state": { "title": "US state", "minLength": 2, "maxLength": 2, "type": "string", "description": "Two-letter state or territory abbreviation. Search filters apply to the practice location.", "default": "TX" }, "city": { "title": "City (optional)", "maxLength": 100, "type": "string", "description": "City name. Set an empty string to search the entire state. The Austin default also applies when this field is omitted.", "default": "AUSTIN" }, "postalCode": { "title": "ZIP code (optional)", "maxLength": 10, "type": "string", "description": "Five-digit ZIP code or ZIP+4. Clear City when searching outside Austin." }, "enumerationType": { "title": "Provider type", "enum": [ "NPI-2", "NPI-1" ], "type": "string", "description": "Individual providers typically do not have an authorized official; those fields remain empty.", "default": "NPI-2" }, "enrichWebsiteAndContacts": { "title": "Find website, emails, social links and booking software", "type": "boolean", "description": "Discover a public website, confirm its practice identity, and inspect its homepage. Best effort; enrichment can be unavailable or blocked.", "default": false }, "maxItems": { "title": "Maximum saved records", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Includes successful records and free error rows. Free Apify accounts are limited to 25 saved rows per run.", "default": 100 }, "timeoutSecs": { "title": "Request timeout (seconds)", "minimum": 3, "maximum": 60, "type": "integer", "description": "Total timeout for each request operation, including redirect and transport fallbacks.", "default": 15 }, "maxConcurrency": { "title": "Maximum concurrent enrichments", "minimum": 1, "maximum": 100, "type": "integer", "description": "The federal API is paginated sequentially; this controls optional website tasks.", "default": 25 }, "proxyConfiguration": { "title": "Website proxy configuration (optional)", "type": "object", "description": "The federal API always uses a direct connection. Websites use direct access first, then available datacenter proxies on HTTP 403/429/503. Configured Apify groups require explicit opt-in. Custom proxy URLs are used directly; explicitly disabling Apify proxy forces direct website requests." } } }, "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 } } } } } } } } } }