{ "openapi": "3.0.1", "info": { "title": "NPI Registry Scraper: US Healthcare Providers", "description": "Look up US doctors, clinics and hospitals in the official NPPES NPI Registry by number, name, speciality or location. Flattens addresses, taxonomies and licences into clean columns. No key, no login, no scraping.", "version": "0.0", "x-build-id": "TIn76nwgXnn226Zyt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winterlock~npi-registry-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winterlock-npi-registry-scraper", "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/winterlock~npi-registry-scraper/runs": { "post": { "operationId": "runs-sync-winterlock-npi-registry-scraper", "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/winterlock~npi-registry-scraper/run-sync": { "post": { "operationId": "run-sync-winterlock-npi-registry-scraper", "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" ], "properties": { "mode": { "title": "What to do", "enum": [ "search", "lookup" ], "type": "string", "description": "Search the registry by name, speciality or location, or look up specific NPI numbers.", "default": "search" }, "npiNumbers": { "title": "NPI numbers", "type": "array", "description": "For Look up. Ten-digit NPI numbers, one per line. A registry URL containing the number works too.", "items": { "type": "string" } }, "providerType": { "title": "Provider type", "enum": [ "any", "individual", "organization" ], "type": "string", "description": "Individuals are NPI-1 records (doctors, nurses, therapists). Organizations are NPI-2 records (clinics, hospitals, pharmacies, labs).", "default": "any" }, "lastName": { "title": "Last name", "type": "string", "description": "Individual providers only. A trailing * works as a wildcard, for example smit*." }, "firstName": { "title": "First name", "type": "string", "description": "Individual providers only." }, "organizationName": { "title": "Organization name", "type": "string", "description": "Organizations only. A trailing * works as a wildcard." }, "taxonomyDescription": { "title": "Speciality (taxonomy)", "type": "string", "description": "The provider's speciality as NPPES describes it, such as Pediatrics, Internal Medicine, Pharmacy or Physical Therapist." }, "city": { "title": "City", "type": "string", "description": "For Search. Practice-location city, matched exactly the way NPPES stores it, for example 'KANSAS CITY'. Combine with State for a precise match." }, "state": { "title": "State", "type": "string", "description": "Two-letter state code such as KS, CA, NY. NPPES will not accept a state on its own, so pair it with a city, name or speciality." }, "postalCode": { "title": "Postal code", "type": "string", "description": "A 5-digit ZIP, or a prefix with a trailing * such as 672*." }, "countryCode": { "title": "Country code", "type": "string", "description": "Two-letter code. Defaults to all countries; use US to limit to the United States." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1200, "type": "integer", "description": "NPPES returns at most 200 per page and stops paging after 1,200 records for a single query.", "default": 100 }, "maxItems": { "title": "Max items in total", "minimum": 1, "type": "integer", "description": "Stop the run after saving this many items. Leave empty for no limit." }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "The registry paginates in order, so this mostly matters when looking up many NPI numbers at once.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed. The NPPES API is open to datacenter traffic.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }