nvd-api 0.4.5

NVD API 2.0 Python API

NVD API client is a community driven NVD API 2.0 client. This client support Vulnerabilities API and Products API.

Getting Start

Products / CPE API

This API’s simple example is bellow.

from client import NvdApiClient
from pprint import pprint

client = NvdApiClient()

response = client.get_cpes(
    cpe_name_id="87316812-5F2C-4286-94FE-CC98B9EAEF53",
    results_per_page=1,
    start_index=0
)
pprint(response)

get_cpes method check API’s all constraints and limitations.

• cpeNameId and matchCriteriaId must be uuid format.

• cpeMatchString must be CPEv2.3 format.

• If filtering by keywordExactMatch, keywordSearch is REQUIRED.

• If filtering by the last modified date, both lastModStartDate and lastModEndDate are REQUIRED.

• resultsPerPage’s maximum allowable limit is 10,000.

Products / Match Criteria API

This API’s simple example is bellow.

from client import NvdApiClient
from pprint import pprint

client = NvdApiClient()

response = client.get_cpe_match(
    cve_id="CVE-2022-32223",
    results_per_page=1,
    start_index=0
)
pprint(response)

get_cpe_match method check API’s all constraints and limitations.

• cveId is must be CVE ID format.

• If filtering by the last modified date, both lastModStartDate and lastModEndDate are REQUIRED.

• matchCriteriaId must be uuid format.

• resultsPerPage’s maximum allowable limit is 5,000.

Vulnerabilities / CVE API

This API’s simple example is bellow.

from client import NvdApiClient
from pprint import pprint

client = NvdApiClient()

response = client.get_cves(
    cpe_name="cpe:2.3:o:debian:debian_linux:3.0:*:*:*:*:*:*:*",
    cvss_v2_metrics="AV:L/AC:L/Au:N/C:C/I:C/A:C",
    cvss_v2_severity="HIGH",
    results_per_page=1,
    start_index=1
)
pprint(response)

Vulnerabilities / CVE Change History API

This API’s simple example is bellow.

from client import NvdApiClient
from pprint import pprint

client = NvdApiClient()

response = client.get_cve_history(
    change_start_date="2021-08-04T00:00:00.000",
    change_end_date="2021-10-23T00:00:00.000",
    event_name="CVE Rejected",
    results_per_page=1,
    start_index=1
)
pprint(response)

get_cve_history method check API’s all constraints and limitations.

• If filtering by the change date, both changeStartDate and changeEndDate are REQUIRED.

• cveId is must be CVE ID format.

• resultsPerPage’s maximum allowable limit is 5,000.