{ "openapi": "3.0.1", "info": { "title": "US Healthcare Providers (NPI Registry) Scraper", "description": "Use this when you need US healthcare organizations or practitioners from the official NPI Registry (NPPES): clinics, hospitals, pharmacies, dentists by specialty, city, state or ZIP, with address, phone, taxonomy and NPI. No key; large areas split automatically. Pay per result.", "version": "0.1", "x-build-id": "73tsXlh1AoKBl6mz1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hexadatalabs~us-healthcare-providers-npi-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hexadatalabs-us-healthcare-providers-npi-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/hexadatalabs~us-healthcare-providers-npi-scraper/runs": { "post": { "operationId": "runs-sync-hexadatalabs-us-healthcare-providers-npi-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/hexadatalabs~us-healthcare-providers-npi-scraper/run-sync": { "post": { "operationId": "run-sync-hexadatalabs-us-healthcare-providers-npi-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": { "taxonomies": { "title": "Specialties (taxonomy descriptions)", "type": "array", "description": "NPPES taxonomy descriptions, one per line, e.g. \"Dentist\", \"Family Medicine\", \"Pharmacy\", \"Physical Therapist\", \"Clinic/Center\". A wildcard * at the end matches sub-specialties (\"Dent*\" = Dentist, Dental Hygienist...; at least two characters before the *). Full list: https://taxonomy.nucc.org/", "items": { "type": "string" } }, "organizationName": { "title": "Organization name", "type": "string", "description": "Filter by organization name, wildcard * at the end allowed, e.g. \"Mayo*\", \"CVS*\". Organizations only." }, "city": { "title": "City", "type": "string", "description": "City of the practice location, e.g. \"Austin\". NPPES matches the city name as registered (usually upper case, exact word)." }, "state": { "title": "State", "enum": [ "", "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "PR", "GU", "VI", "AS", "MP" ], "type": "string", "description": "Two-letter US state or territory code of the practice location, e.g. TX. Must be combined with another filter." }, "postalCodes": { "title": "ZIP codes or prefixes", "type": "array", "description": "ZIP codes (\"78701\") or prefixes of at least two digits (\"787\" = all of Austin area, \"78\" = central Texas). Use prefixes to cover a region without naming every city.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code of the practice location. NPPES is a US registry; a few providers abroad (e.g. MX, CA) are registered too.", "default": "US" }, "includeIndividuals": { "title": "Include individual practitioners", "type": "boolean", "description": "Off: only organizations (NPI-2: clinics, hospitals, pharmacies, group practices). On: also individual practitioners (NPI-1: physicians, dentists, nurses), which are named persons; turn on only if you have a lawful basis to use their public practice data.", "default": false }, "enumeratedFrom": { "title": "Registered from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only providers whose NPI was issued on or after this date (YYYY-MM-DD), e.g. new clinics since 2026-01-01. Applied after download, so the run still scans the area." }, "onlyNewSinceLastRun": { "title": "Only new since last run", "type": "boolean", "description": "Use this on a schedule: the Actor remembers the NPIs it delivered (shared store \"hexadata-us-healthcare-providers-npi\" in your account) and returns only providers it has not delivered before. The first run saves everything that matches.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many providers. NPPES returns at most 1,200 per query; the Actor splits larger areas by ZIP prefix automatically, so a whole state is possible.", "default": 100 }, "includeContacts": { "title": "Include authorized official", "type": "boolean", "description": "Add the organization's authorized official (name, title, phone) as published in NPPES. Off by default because it names an individual.", "default": false }, "includeRaw": { "title": "Include raw NPPES record", "type": "boolean", "description": "Attach the original NPPES API record under \"raw\" (all addresses, identifiers, endpoints, practice locations).", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "NPPES is an open API that does not need a proxy; leave it off.", "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 } } } } } } } } } }