{ "openapi": "3.0.1", "info": { "title": "Healthcare Organizations Finder (NPI Registry)", "description": "US healthcare organizations (NPI type 2) from the official CMS NPI Registry—specialty, address, phone and enumeration date.", "version": "1.0", "x-build-id": "fuvoKH5uvEWWCLq5h" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/great_stuff~healthcare-organizations-npi/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-great_stuff-healthcare-organizations-npi", "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/great_stuff~healthcare-organizations-npi/runs": { "post": { "operationId": "runs-sync-great_stuff-healthcare-organizations-npi", "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/great_stuff~healthcare-organizations-npi/run-sync": { "post": { "operationId": "run-sync-great_stuff-healthcare-organizations-npi", "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": "Specialties (taxonomy descriptions)", "type": "array", "description": "NPI taxonomy descriptions, e.g. \"Dentist\", \"Home Health\", \"Physical Therapist\", \"Pharmacy\", \"Clinic/Center\", \"Hospice Care, Community Based\". One search runs per specialty and location.", "default": [], "items": { "type": "string" } }, "organizationName": { "title": "Organization name", "type": "string", "description": "Optional name search. End with * for \"starts with\", e.g. \"smile*\". At least 2 characters.", "default": "" }, "states": { "title": "States", "type": "array", "description": "2-letter state codes, e.g. TX, CA.", "default": [], "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "City names (needs a state). Use either cities or ZIP codes.", "default": [], "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes or prefixes", "type": "array", "description": "Full ZIPs (78701) or 2-4 digit prefixes (787) for a whole area. Use either cities or ZIP codes.", "default": [], "items": { "type": "string" } }, "addressPurpose": { "title": "Match location on", "enum": [ "PRIMARY", "LOCATION", "MAILING", "ANY" ], "type": "string", "description": "PRIMARY = main practice location (recommended). LOCATION = any practice location. MAILING = mailing address. ANY = any address.", "default": "PRIMARY" }, "strictTaxonomyMatch": { "title": "Strict specialty match", "type": "boolean", "description": "The registry also returns related specialties (\"Home Health\" includes \"In Home Supportive Care\"). Keep only organizations with a taxonomy that contains your exact phrase.", "default": true }, "enumeratedAfter": { "title": "NPI issued on or after", "type": "string", "description": "Optional YYYY-MM-DD. Keep only organizations that received their NPI on or after this date, e.g. to find new practices.", "default": "" }, "excludeSubparts": { "title": "Exclude subparts", "type": "boolean", "description": "Drop organizational subparts (departments or branches with their own NPI).", "default": false }, "includeAuthorizedOfficial": { "title": "Include authorized official", "type": "boolean", "description": "Add the organization's authorized official (name, title, phone) as published in the registry. Off by default; turn on only if you have a legitimate business purpose.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many organizations. One search returns at most 1,200 records; split large areas by ZIP code.", "default": 100 } } }, "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 } } } } } } } } } }