{
  "openapi": "3.0.1",
  "info": {
    "title": "NPI Registry Scraper",
    "description": "Search and export public CMS NPI Registry healthcare provider records by NPI, specialty, name, organization, and location.",
    "version": "0.1",
    "x-build-id": "xbf2cnIwt4CGlb0gx"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/fetch_cat~npi-registry-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-fetch_cat-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/fetch_cat~npi-registry-scraper/runs": {
      "post": {
        "operationId": "runs-sync-fetch_cat-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/fetch_cat~npi-registry-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-fetch_cat-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": {
          "npiNumbers": {
            "title": "NPI numbers",
            "type": "array",
            "description": "Exact 10-digit NPI numbers to look up first. If search filters are also supplied, the search follows these lookups until the shared result limit is reached. With no NPIs or search criteria, the Actor looks up the sample NPI 1679576722.",
            "items": {
              "type": "string",
              "pattern": "^\\s*[0-9]{10}\\s*$"
            }
          },
          "taxonomyDescription": {
            "title": "Taxonomy or specialty",
            "pattern": "^(?!\\s*[^*]?\\*)[\\s\\S]*$",
            "type": "string",
            "description": "Provider specialty text, such as Cardiology or Family Medicine. Wildcards require at least two leading characters, such as Ca*."
          },
          "firstName": {
            "title": "First name",
            "pattern": "^(?!\\s*[^*]?\\*)[\\s\\S]*$",
            "type": "string",
            "description": "First name for individual provider searches. Wildcards require at least two leading characters, such as Jo*."
          },
          "countryCode": {
            "title": "Country code",
            "pattern": "^[A-Za-z]{2}$",
            "minLength": 2,
            "maxLength": 2,
            "type": "string",
            "description": "Two-letter country code to refine a search. The input form defaults to US; when omitted from an API input the Actor sends no country filter. Country alone does not start a search.",
            "default": "US"
          },
          "enumerationType": {
            "title": "Enumeration type",
            "enum": [
              "",
              "NPI-1",
              "NPI-2"
            ],
            "type": "string",
            "description": "Filter search results to individuals (NPI-1) or organizations (NPI-2). Leave blank to include both. Without a specialty, provider or organization name, city, state, or postal code, search is skipped with a warning. State also requires another specialty, name, organization, city or postal-code filter. Explicit exact NPI lookups still run and are not filtered by this setting.",
            "default": ""
          },
          "maxResults": {
            "title": "Maximum provider records",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Maximum provider records to save across exact lookups and search; default 20. The Actor caps this at 1,200 even if a larger value is entered. Fewer records may be available; narrow filters for separate searches instead of expecting a full national export.",
            "default": 20
          },
          "lastName": {
            "title": "Last name",
            "pattern": "^(?!\\s*[^*]?\\*)[\\s\\S]*$",
            "type": "string",
            "description": "Last name for individual provider searches. Wildcards require at least two leading characters, such as Sm*."
          },
          "organizationName": {
            "title": "Organization name",
            "pattern": "^(?!\\s*[^*]?\\*)[\\s\\S]*$",
            "type": "string",
            "description": "Organization, clinic, pharmacy, hospital, or group practice name. Wildcards require at least two leading characters, such as Ho*."
          },
          "city": {
            "title": "City",
            "pattern": "^(?!\\s*[^*]?\\*)[\\s\\S]*$",
            "type": "string",
            "description": "Provider practice city. Wildcards require at least two leading characters, such as Se*."
          },
          "state": {
            "title": "State",
            "pattern": "^[A-Za-z]{2}$",
            "minLength": 2,
            "maxLength": 2,
            "type": "string",
            "description": "Two-letter US state code, such as WA, CA, NY, or TX. CMS requires another specialty, name, organization, city or postal-code filter; state alone (even with country or entity type) skips search with a warning. Supplied exact NPIs still run."
          },
          "postalCode": {
            "title": "Postal code",
            "pattern": "^(?!\\s*[^*]?\\*)[\\s\\S]*$",
            "type": "string",
            "description": "US ZIP/postal code filter accepted by the NPI Registry API. Wildcards require at least two leading characters, such as 98*."
          },
          "includeRaw": {
            "title": "Include raw CMS record",
            "type": "boolean",
            "description": "Include the complete source record in the `raw` field for advanced enrichment workflows.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional connection settings for public CMS Registry requests. Omitted settings and the default useApifyProxy=false make direct requests. Valid Apify Proxy settings or your own proxy URLs are used as supplied from the start; there is no automatic proxy fallback. Leave disabled unless your workflow requires a proxy. Managed proxy usage may incur Apify charges. Malformed or unsupported settings are rejected before retrieval; no paid fallback is substituted. An explicitly supplied empty object retains Apify SDK managed-proxy defaults, unlike omitting this field.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}