{ "openapi": "3.0.1", "info": { "title": "NPI Registry Scraper: US doctors and providers by specialty", "description": "Build prospect files or verify credentials: nurses, therapists, clinics, hospitals and pharmacies within US healthcare providers, with identifiers and contacts from the authoritative federal source. Costs 1 USD per 1,000 providers.", "version": "0.1", "x-build-id": "ddDSLLPADxipK0nym" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bepolabs~npi-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bepolabs-npi-registry", "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/bepolabs~npi-registry/runs": { "post": { "operationId": "runs-sync-bepolabs-npi-registry", "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/bepolabs~npi-registry/run-sync": { "post": { "operationId": "run-sync-bepolabs-npi-registry", "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)", "type": "array", "description": "Specialty descriptions as NPPES names them, e.g. Cardiovascular Disease, Dentist, Nurse Practitioner or Physical Therapist; a trailing * matches the start (Dent*). One search per specialty and state.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Two-letter US state codes, e.g. TX or CA; each search runs once per state. A state alone is not a search: add a specialty, name or organization.", "items": { "type": "string" } }, "names": { "title": "Provider names", "type": "array", "description": "Individual providers: 'Jane Smith', 'Smith, Jane' or a last name; a trailing * after 2 letters matches the start (Smi*).", "items": { "type": "string" } }, "organizations": { "title": "Organization names", "type": "array", "description": "Hospitals, clinics, pharmacies and other organizations, e.g. Mayo Clinic or CVS*.", "items": { "type": "string" } }, "npiNumbers": { "title": "NPI numbers", "type": "array", "description": "Look up these 10-digit NPIs directly (check digit verified), e.g. 1003000126.", "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "Narrow every search to this city of the practice or mailing address, e.g. Austin." }, "postalCode": { "title": "ZIP code", "type": "string", "description": "Narrow every search to this ZIP code; a trailing * matches the start (787*)." }, "providerType": { "title": "Provider type for specialty searches", "enum": [ "any", "individual", "organization" ], "type": "string", "description": "individual (doctors, nurses, therapists), organization (hospitals, clinics, pharmacies) or any.", "default": "any" }, "primaryTaxonomyOnly": { "title": "Main specialty only", "type": "boolean", "description": "Keep only providers whose primary specialty matches the searched specialty (NPPES also matches secondary ones).", "default": false }, "maxItemsPerQuery": { "title": "Max providers per search", "minimum": 1, "maximum": 1200, "type": "integer", "description": "Per specialty, name or organization and state (1 to 1,200, the NPI Registry's own limit per query; add a city or ZIP to reach more).", "default": 200 }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries per request on timeouts, rate limits and server errors.", "default": 3 } } }, "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 } } } } } } } } } }