{
  "openapi": "3.0.1",
  "info": {
    "title": "NPPES NPI Registry Scraper - US Healthcare Provider Lookup",
    "description": "Scrape the official CMS NPPES NPI Registry for US healthcare providers and organizations: NPI, credentials, addresses, phone and fax, specialty taxonomies and license numbers. Filter by name, NPI, specialty, state, city or ZIP. Export CSV, Excel, JSON. No login or API key.",
    "version": "0.1",
    "x-build-id": "0cvdL8aoTF05b7FeQ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/recordsdata~nppes-npi-registry-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-recordsdata-nppes-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/recordsdata~nppes-npi-registry-scraper/runs": {
      "post": {
        "operationId": "runs-sync-recordsdata-nppes-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/recordsdata~nppes-npi-registry-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-recordsdata-nppes-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": {
          "maxItems": {
            "title": "Max results (records)",
            "minimum": 1,
            "type": "integer",
            "description": "How many provider records to return and be charged for, for example 200. Free plan runs are limited to 10.",
            "default": 200
          },
          "enumerationType": {
            "title": "Provider type",
            "enum": [
              "ANY",
              "NPI-1",
              "NPI-2"
            ],
            "type": "string",
            "description": "Individuals (NPI-1), organizations (NPI-2) or both. Combine with a name, specialty, city or ZIP; on its own the registry rejects it.",
            "default": "ANY"
          },
          "npiNumbers": {
            "title": "Exact NPI numbers (optional)",
            "type": "array",
            "description": "One 10-digit NPI per line, for example 1821205840. Unknown numbers are skipped and not charged. When filled, the name, place and specialty fields below are ignored.",
            "items": {
              "type": "string"
            }
          },
          "firstName": {
            "title": "First name starts with (optional)",
            "type": "string",
            "description": "For individual providers, for example Jo. Add a last name, state or specialty to narrow it down.",
            "default": ""
          },
          "lastName": {
            "title": "Last name starts with (optional)",
            "type": "string",
            "description": "For individual providers, for example Smith. Combine with a state or specialty."
          },
          "nameSearchTarget": {
            "title": "First and last name refer to",
            "enum": [
              "PROVIDER",
              "AUTHORIZED_OFFICIAL"
            ],
            "type": "string",
            "description": "Provider: the clinician or organization itself (default). Authorized official: the person who signed an organization's NPI application, which finds the organizations someone runs.",
            "default": "PROVIDER"
          },
          "organizationName": {
            "title": "Organization name starts with (optional)",
            "type": "string",
            "description": "Hospitals, clinics, pharmacies and similar, for example hospital or Mayo Clinic. Prefilled with hospital; clear it for person searches."
          },
          "taxonomyDescription": {
            "title": "Specialty (optional)",
            "type": "string",
            "description": "Specialty text, for example Family Medicine, Nurse Practitioner, Dentist or General Acute Care Hospital."
          },
          "state": {
            "title": "State (2 letters, optional)",
            "type": "string",
            "description": "One US state or territory code, for example TX. For several, use the next field."
          },
          "states": {
            "title": "Several states (optional)",
            "type": "array",
            "description": "One 2-letter code per line, for example FL and TX. Searched one after the other and merged without duplicates.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "city": {
            "title": "City (optional)",
            "type": "string",
            "description": "City of the address, for example Houston."
          },
          "cities": {
            "title": "Several cities (optional)",
            "type": "array",
            "description": "One city per line, for example Houston and Dallas. Merged without duplicates.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "postalCode": {
            "title": "ZIP code (optional)",
            "type": "string",
            "description": "5 digits such as 77030, 9 digits, or a prefix like 770* (2 to 4 digits plus *)."
          },
          "addressPurpose": {
            "title": "Which address the place filters use",
            "enum": [
              "ANY",
              "LOCATION",
              "MAILING"
            ],
            "type": "string",
            "description": "Any address (default), practice location only (where care is given) or mailing address only.",
            "default": "ANY"
          },
          "lastUpdatedSince": {
            "title": "Record updated since (optional)",
            "type": "string",
            "description": "Date in YYYY-MM-DD, for example 2026-01-01. The registry cannot filter by date, so older records are read and skipped for free; keep the search narrow (state, city or specialty). The scan stops after 90 seconds without a new match."
          },
          "includeRaw": {
            "title": "Add the raw registry record",
            "type": "boolean",
            "description": "On: adds the full, unmodified NPPES record to each row. Larger dataset.",
            "default": false
          },
          "onlyNew": {
            "title": "Only new or updated providers",
            "type": "boolean",
            "description": "On: skips providers an earlier run of the same search already delivered with the same last-updated date (not returned, not charged). Changed ones come back with changeType updated. Keep the search narrow because the scan stops after 90 seconds without a new result.",
            "default": false
          },
          "stateKey": {
            "title": "Monitor name (optional)",
            "type": "string",
            "description": "One name per saved search, for example texas-hospitals. Empty derives a name from your inputs.",
            "default": ""
          },
          "resetSeen": {
            "title": "Forget previous results",
            "type": "boolean",
            "description": "On: clears this monitor's memory before the run, so every provider counts as new again.",
            "default": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}