https://github.com/neonwatty/pynih
A Python interface for NIH Reporter APIs
https://github.com/neonwatty/pynih
api nih python
Last synced: 4 months ago
JSON representation
A Python interface for NIH Reporter APIs
- Host: GitHub
- URL: https://github.com/neonwatty/pynih
- Owner: neonwatty
- License: mit
- Created: 2023-04-19T21:07:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T16:56:47.000Z (8 months ago)
- Last Synced: 2025-06-12T11:04:22.864Z (4 months ago)
- Topics: api, nih, python
- Language: Jupyter Notebook
- Homepage:
- Size: 80.1 KB
- Stars: 9
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/jermwatt/pynih/actions/workflows/python-app.yml)
# pynih - a Python interface for the NIH's Reporter APIs
pynih is a Python library that provides easy access to the NIH's [Reporter APIs](https://api.reporter.nih.gov/).
## Installation
`pip install pynih`
## Example usage
This example can be executed in [this example notebook](https://colab.research.google.com/github/jermwatt/pynih/blob/main/pynih_example_usage.ipynb#scrollTo=mTC2IDzs7_l1).
```python
from pynih import apis
# illustration of project api usage
search_criteria = {'appl_ids':[9795459]}
include_fields = ['ApplId', 'ProjectTitle']
project_data = apis.query_project_api(include_fields=include_fields, search_criteria=search_criteria)
# illustration of publication api usage
search_criteria = {'pmid':'26657764'}
publication_data = apis.query_publication_api(search_criteria=search_criteria)
```
### `query_project_api` input parameters
The project API `query_project_api` has the following input parameters:
`search_criteria` - query search criteria. Example: `{"use_relevance": True, "fiscal_years": [2023],"include_active_projects": True}`
`include_fields` - fields to include in return payload. Example: The output result payload would have only ten fields/columns: "include_fields": `[ "ApplId","SubprojectId","FiscalYear","OrgName","OrgCity", "OrgState","OrgStateName","DeptType", "ProjectNum","OrgCountry" ]`. Default value: all.
`limit` - number of entries to return (maximum 500 per query). Default value: 1.
`offset` - Starting counter for return items (projects). Default value: 0. Maximum allowable value: 14,999 or length of records.
See [official documentation](https://api.reporter.nih.gov/#/Search/post_v2_projects_search) for further information on these inputs.
## Notice of Non-Affiliation and Disclaimer
The author of this library is not affiliated, associated, authorized, endorsed by, or in any way officially connected with the NIH, or any of its subsidiaries or its affiliates. The official NIH Reporter website can be found at https://reporter.nih.gov/