API wrapper around the NPPES API
Project description
NPyI
API wrapper around the NPPES API. https://npiregistry.cms.hhs.gov/registry/help-api
Documentation: https://npyi.readthedocs.io/en/latest/
Install
pip install npyi
Examples
from npyi import npi
# sample search by first_name / last_name
response = npi.search(search_params={'first_name': 'Andrew', 'last_name': 'Jackson'})
print(response.keys()) # dict_keys(['result_count', 'results'])
first_entry = response['results'][0]
print(first_entry['basic']['first_name']) # ANDREW
print(first_entry['basic']['last_name']) # JACKSON
# sample search by NPI number
response = search(search_params={'number': '1417367343'})
print(response['result_count']) # 1
print(response['results'][0]['number']) # 1417367343
# sample search by city
response = search(search_params={'city': 'San Francisco'})
first_entry = response['results'][0]
print(len(first_entry['addresses'])) # 2 (different address purposes - LOCATION and MAILING)
print(first_entry['addresses'][0]['city']) # SAN FRANCISCO
# limit example
response = search(search_params={'first_name': 'Andrew', 'city': 'New York'}, limit=50)
print(response['result_count']) # 50
response = search(search_params={'first_name': 'Andrew', 'city': 'New York'}, limit=1000)
print(response['result_count']) # 200 (200 is the max)
response = search(search_params={'first_name': 'Andrew', 'city': 'New York'})
print(response['result_count']) # 10 (10 is the default)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
npyi-0.1.3.tar.gz
(4.7 kB
view details)
Built Distribution
npyi-0.1.3-py3-none-any.whl
(6.3 kB
view details)
File details
Details for the file npyi-0.1.3.tar.gz
.
File metadata
- Download URL: npyi-0.1.3.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a36c81a592d4945774a568b9c11f957f3b6d7197169928d21f5a6351eb554762 |
|
MD5 | 039f9a60c0c4a74ecfb8ae52ab75eac6 |
|
BLAKE2b-256 | 12b5e81a80c05f652b5fbdf2ef0b34f493a4deccf94e6ec27622735491b809a2 |
File details
Details for the file npyi-0.1.3-py3-none-any.whl
.
File metadata
- Download URL: npyi-0.1.3-py3-none-any.whl
- Upload date:
- Size: 6.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b61b2804be1eb0ce44424bfad25f4ff97bd5413a2204d5ac50030ec43744099 |
|
MD5 | 3a1ca57dfcf7017252c059307801f505 |
|
BLAKE2b-256 | 6107780b3845ab39a0ecc488e3838ecdee2716bf03c78cef134eccb30f6dfff3 |