npyi¶

npyi.npi.search(search_params, version='2.1', limit=None, skip=None)¶

Main wrapper function around the NPPES API.

Parameters:	search_params (dict) – Search criteria to the NPPES API. See VALID_SEARCH_PARAMS for list of valid search params and https://npiregistry.cms.hhs.gov/registry/help-api for parameter descriptions. version (str/int, optional) – NPPES API version to use, defaults to ‘2.1’. limit (int, optional) – Limit results returned from API, defaults to None. If no value is passed, 10 results are returned by default. skip (int, optional) – Bypass first N results from the response, defaults to None.
Returns:	API response as a dictionary, containing a “results_count” and “results” key.
Return type:	dict

exceptions¶

exception npyi.exceptions.InvalidAddressPurposeException¶: Exception for invalid address_purpose values

exception npyi.exceptions.InvalidSearchParamException¶: Exception for invalid search parameters

exception npyi.exceptions.InvalidUseFirstNameAliasException¶: Exception for invalid used_first_name_alias values

exception npyi.exceptions.InvalidVersionException¶: Exception for invalid NPPES API versions