{"id":16107326,"url":"https://github.com/neonwatty/pynih","last_synced_at":"2025-06-14T19:38:54.829Z","repository":{"id":153732836,"uuid":"630184543","full_name":"neonwatty/pynih","owner":"neonwatty","description":"A Python interface for NIH Reporter APIs","archived":false,"fork":false,"pushed_at":"2025-02-04T16:56:47.000Z","size":82,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-12T11:04:22.864Z","etag":null,"topics":["api","nih","python"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neonwatty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-04-19T21:07:41.000Z","updated_at":"2025-02-04T16:57:28.000Z","dependencies_parsed_at":"2025-05-27T21:07:39.487Z","dependency_job_id":"15e39c07-0168-419d-a41f-ecaa7c363e4c","html_url":"https://github.com/neonwatty/pynih","commit_stats":null,"previous_names":["neonwatty/pynih","jermwatt/pynih"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/neonwatty/pynih","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neonwatty%2Fpynih","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neonwatty%2Fpynih/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neonwatty%2Fpynih/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neonwatty%2Fpynih/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neonwatty","download_url":"https://codeload.github.com/neonwatty/pynih/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neonwatty%2Fpynih/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259872800,"owners_count":22924638,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","nih","python"],"created_at":"2024-10-09T19:16:08.079Z","updated_at":"2025-06-14T19:38:54.800Z","avatar_url":"https://github.com/neonwatty.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Python application](https://github.com/jermwatt/pynih/actions/workflows/python-app.yml/badge.svg)](https://github.com/jermwatt/pynih/actions/workflows/python-app.yml)\n\n# pynih - a Python interface for the NIH's Reporter APIs\n\npynih is a Python library that provides easy access to the NIH's [Reporter APIs](https://api.reporter.nih.gov/).\n\n## Installation\n\n`pip install pynih`\n\n## Example usage\n\nThis 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).\n\n```python\nfrom pynih import apis\n\n# illustration of project api usage\nsearch_criteria = {'appl_ids':[9795459]}\ninclude_fields = ['ApplId', 'ProjectTitle']\nproject_data = apis.query_project_api(include_fields=include_fields, search_criteria=search_criteria)\n\n# illustration of publication api usage\nsearch_criteria = {'pmid':'26657764'}\npublication_data = apis.query_publication_api(search_criteria=search_criteria)\n```\n\n### `query_project_api` input parameters\n\nThe project API `query_project_api` has the following input parameters:\n\n`search_criteria` - query search criteria.  Example: `{\"use_relevance\": True, \"fiscal_years\": [2023],\"include_active_projects\": True}`\n\n`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.\n\n`limit` - number of entries to return (maximum 500 per query).  Default value: 1.\n\n`offset` - Starting counter for return items (projects). Default value: 0.  Maximum allowable value: 14,999 or length of records.\n\nSee [official documentation](https://api.reporter.nih.gov/#/Search/post_v2_projects_search) for further information on these inputs.\n\n\n## Notice of Non-Affiliation and Disclaimer \nThe 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/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneonwatty%2Fpynih","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneonwatty%2Fpynih","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneonwatty%2Fpynih/lists"}