https://github.com/vehemont/nvdlib
A simple wrapper for the National Vulnerability CVE/CPE API
https://github.com/vehemont/nvdlib
api cve library nist nvd nvdlib python python3 vulnerability wrapper
Last synced: 20 days ago
JSON representation
A simple wrapper for the National Vulnerability CVE/CPE API
- Host: GitHub
- URL: https://github.com/vehemont/nvdlib
- Owner: vehemont
- License: mit
- Created: 2021-10-15T17:46:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-06T20:55:45.000Z (11 months ago)
- Last Synced: 2026-05-29T13:06:15.443Z (24 days ago)
- Topics: api, cve, library, nist, nvd, nvdlib, python, python3, vulnerability, wrapper
- Language: Python
- Homepage: https://nvdlib.com
- Size: 6.59 MB
- Stars: 114
- Watchers: 11
- Forks: 33
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
## Simple NIST NVD API wrapper library
**NVDlib** is a Python library that allows you to interface with the [NIST National Vulnerability Database](https://nvd.nist.gov/) (NVD), pull vulnerabilities (CVEs), and [Common Platform Enumeration](https://nvd.nist.gov/products/cpe) (CPEs) into easily accessible objects.
[](https://pypi.org/project/nvdlib/)
[](https://nvdlib.readthedocs.io/en/latest/?badge=latest)
---
### Features
- Search the NVD for CVEs using all parameters allowed by the NVD API (recently updated to utilize version 2 of the API). Including search criteria such as CVE publish and modification date, keywords, severity, score, or CPE name.
- Search CPE names by keywords, CPE match strings, or modification dates. Then pull the CVE ID's that are relevant to those CPEs.
- Retrieve details on individual CVEs, their relevant CPE names, and more.
- Built in rate limiting according to [NIST NVD recommendations](https://nvd.nist.gov/developers/start-here).
Get an API key (https://nvd.nist.gov/developers/request-an-api-key) to allow for a delay argument to be passed. Otherwise it is 6 seconds between requests by default.
### Install
```bash
$ pip install nvdlib
```
### Demo
```python
>>> import nvdlib
>>> r = nvdlib.searchCVE(cveId='CVE-2021-26855')[0]
>>> print(r.v31severity + ' - ' + str(r.v31score))
CRITICAL - 9.8
>>> print(r.descriptions[0].value)
Microsoft Exchange Server Remote Code Execution Vulnerability This CVE ID is unique from CVE-2021-26412,
CVE-2021-26854, CVE-2021-26857, CVE-2021-26858, CVE-2021-27065, CVE-2021-27078.
>>> print(r.v31vector)
CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H
```
### Development
Run the tests with
```bash
$ pip install -e '.[dev]'
$ pytest
```
### Documentation
https://nvdlib.com
#### More information
This is my first attempt at creating a library while utilizing all my Python experience from classes to functions.
For more information on the NIST NVD API for CPE and CVEs, see the documentation here:
https://nvd.nist.gov/General/News/New-NVD-CVE-CPE-API-and-SOAP-Retirement
---
This product uses data from the NVD API but is not endorsed or certified by the NVD.