Skip to main content

Python application

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.

Installation

pip install pynih

Example usage

This example can be executed in this example notebook.

from pynih import apis

# illustration of project api usage
search_criteria = {'appl_id':'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 for further information on these inputs.

Metadata

Release files for pynih 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pynih 0.1.3
File Size Uploaded Provenance Actions
pynih-0.1.3.tar.gz 3.1 kB Without provenance Details for pynih-0.1.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pynih 0.1.3
File Interpreter ABI Platform Actions
pynih-0.1.3-py3-none-any.whl Python 3 none any Details for pynih-0.1.3-py3-none-any.whl

Total release size: 6.9 kB

Release files / pynih-0.1.3.tar.gz

Download URL pynih-0.1.3.tar.gz
Size 3.1 kB
Tags Source
SHA-256 checksum
How to use checksums
b4c89dbc64941d6cd0454db0387e14bd854b6251dbc20ba17ab5bb9c2369e365
BLAKE2b-256 checksum
How to use checksums
82154603a39411f0955f7ed72966c6cd4301642c5df70bb267f6a55a1f2b2d78
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release files / pynih-0.1.3-py3-none-any.whl

Download URL pynih-0.1.3-py3-none-any.whl
Size 3.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4b481c8f28bb28814b63039af8d678a85dc716a399dc79fe311c06179b4997d7
BLAKE2b-256 checksum
How to use checksums
3dd528b3cff8c40d2924234e23e50647b114a237968188ddc10df883a6e7d2fb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Security for pynih 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page