{ "openapi": "3.0.1", "info": { "title": "NPI Registry Scraper & API - US Doctors, Dentists & Clinics", "description": "For medical device and pharma sales, credentialing and provider directories: search the official NPPES registry for US doctors, dentists and clinics by specialty, city, ZIP, surname or organisation. 1,200 unique providers per run with zero duplicate rows. No API key, no login.", "version": "0.1", "x-build-id": "IdDseTTjIpqfOz2Eb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neverempty~npi-registry-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neverempty-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/neverempty~npi-registry-scraper/runs": { "post": { "operationId": "runs-sync-neverempty-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/neverempty~npi-registry-scraper/run-sync": { "post": { "operationId": "run-sync-neverempty-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", "properties": { "specialty": { "title": "Specialty", "type": "string", "description": "A specialty as the registry writes it: dentist, cardiology, physical therapist, pharmacy, nurse practitioner. A description the registry does not know is rejected with its own message rather than returning everybody." }, "state": { "title": "State", "type": "string", "description": "Two-letter state code such as CA or NY. On its own this is refused by the registry - it has to be combined with a city, a postal code, a specialty, a surname or an organisation name." }, "city": { "title": "City", "type": "string", "description": "City name, such as Los Angeles or Boston. Matched against the address the provider registered." }, "postalCode": { "title": "Postal code", "type": "string", "description": "A ZIP code such as 90210. Works on its own without a state." }, "lastName": { "title": "Last name", "type": "string", "description": "Surname of an individual provider. Individual records carry the surname, credential and licence; organisation records carry the legal name and the authorised official instead." }, "firstName": { "title": "First name", "type": "string", "description": "First name of an individual provider." }, "organizationName": { "title": "Organisation name", "type": "string", "description": "Name of a practice, clinic, hospital or supplier, such as Kaiser." }, "npi": { "title": "NPI number", "type": "string", "description": "A specific 10-digit NPI to look up. An NPI that is not in the registry comes back as a search that found nothing, which is a different row from a search the registry rejected." }, "providerType": { "title": "Provider type", "enum": [ "", "NPI-1", "NPI-2" ], "type": "string", "description": "NPI-1 = individual practitioner, NPI-2 = organisation. On its own this is refused by the registry and has to be combined with another field.", "default": "" }, "countryCode": { "title": "Country code", "type": "string", "description": "Two-letter country code, US by default in the registry. On its own this is refused and has to be combined with another field." }, "maxProviders": { "title": "Maximum providers", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many providers to return. You are charged for the rows you actually receive, and a provider is never delivered or charged twice. The registry returns at most 200 per request whatever you ask for, and it stops honouring the paging offset past roughly 1,000 records for one search - beyond that it repeats the same page. This Actor stops there and tells you, so a large number here does not turn into a large bill for repeats. Narrow the search (a city, a postal code, a different specialty) to reach more.", "default": 200 }, "maxRetries": { "title": "Attempts per request", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many times to try a request in total when the registry does not answer.", "default": 4 } } }, "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 } } } } } } } } } }