{ "openapi": "3.0.1", "info": { "title": "NPI Registry Search - US Healthcare Providers", "description": "Searches the NPPES NPI Registry for US doctors, dentists, clinics and other healthcare providers, with practice address, phone and specialty. NPPES caps any one search at 1,200 records and never says how many matched, so every row here carries whether the answer is complete. No key and no login.", "version": "0.1", "x-build-id": "L5OmmdxphmeEd4ca4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gubidonius~npi-registry/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gubidonius-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/gubidonius~npi-registry/runs": { "post": { "operationId": "runs-sync-gubidonius-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/gubidonius~npi-registry/run-sync": { "post": { "operationId": "run-sync-gubidonius-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": { "state": { "title": "State", "type": "string", "description": "Two-letter US state, for example CA. NPPES will not accept a state on its own, so pair it with a city, a postal code or a specialty. It is matched against the mailing address and the extra clinics as well as the practice address." }, "city": { "title": "City", "type": "string", "description": "City name, for example Providence. A trailing * matches a prefix and needs at least two characters before it. NPPES matches this against the practice address, the mailing address and every extra clinic on the record, so a row can come back with an out of state practice address and still be a correct match. practiceLocationCities and mailingCity say which one it was." }, "postalCode": { "title": "Postal code", "type": "string", "description": "Five-digit ZIP, or a prefix with a trailing * such as 029*. A prefix is also what the Actor splits on when a search is too big for NPPES to return whole." }, "taxonomyDescription": { "title": "Specialty", "type": "string", "description": "Provider specialty as NPPES writes it, for example Dermatology or Family Medicine. A trailing * matches a prefix." }, "firstName": { "title": "First name", "type": "string", "description": "Individual providers only. A trailing * matches a prefix." }, "lastName": { "title": "Last name", "type": "string", "description": "Individual providers only. A trailing * matches a prefix." }, "organizationName": { "title": "Organisation name", "type": "string", "description": "Organisations only, for example Kaiser*. A trailing * matches a prefix." }, "npiNumbers": { "title": "NPI numbers", "type": "array", "description": "Look up specific 10-digit NPI numbers directly. Runs alongside the search, and each lookup returns the one matching provider.", "items": { "type": "string" } }, "enumerationType": { "title": "Entity type", "enum": [ "", "NPI-1", "NPI-2" ], "type": "string", "description": "Limit to individual providers or to organisations. Left empty, both are returned and this is the first thing the Actor splits on when a search is too big.", "default": "" }, "activeOnly": { "title": "Active providers only", "type": "boolean", "description": "Drop NPIs whose status is not A. Every one of 4,600 sampled search results was already active, so this changes nothing on a normal search today. It is here because the status field is the source's to change, not ours.", "default": false }, "maxResults": { "title": "Maximum providers", "minimum": 1, "type": "integer", "description": "Stop after this many rows. Being stopped here is reported as maxResults, which is not the same as NPPES running out or capping the search.", "default": 1000 }, "maxRequests": { "title": "Maximum requests", "minimum": 1, "type": "integer", "description": "Ceiling on requests to NPPES. A wide search splits into many smaller ones, and this bounds how far that goes.", "default": 60 } } }, "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 } } } } } } } } } }