https://github.com/youhaveme9/epss-client
EPSS client for python
https://github.com/youhaveme9/epss-client
Last synced: about 1 month ago
JSON representation
EPSS client for python
- Host: GitHub
- URL: https://github.com/youhaveme9/epss-client
- Owner: youhaveme9
- License: mit
- Created: 2025-08-18T14:09:21.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-08-18T14:29:21.000Z (about 2 months ago)
- Last Synced: 2025-08-30T01:43:27.307Z (about 2 months ago)
- Language: Python
- Size: 14.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# EPSS Client
Typed Python client and CLI for the FIRST EPSS (Exploit Prediction Scoring System) API.
## Installation
```bash
pip install epss-client
```
## Quick start
```python
from epss_client import EpssClient
client = EpssClient()
# Single CVE
resp = client.query(cves=["CVE-2022-27225"]) # returns dict with data list
print(resp["data"][0])
# Batch
resp = client.query(cves=["CVE-2022-27225","CVE-2022-27223","CVE-2022-27218"])
# Time series (30 days)
resp = client.query(cves=["CVE-2022-25204"], scope="time-series")
# Top N by EPSS
resp = client.query(order="!epss", limit=100)
# Thresholds
resp = client.query(epss_gt=0.95)
resp = client.query(percentile_gt=0.95)
# Historic by date
resp = client.query(cves=["CVE-2022-26332"], date="2022-03-05")
```
### CLI
```bash
# Show first 100 CVEs
epss query --limit 100
# Single CVE
epss get CVE-2022-27225
# Batch
epss batch CVE-2022-27225 CVE-2022-27223 CVE-2022-27218
# Time series for 30 days
epss get CVE-2022-25204 --scope time-series
# Top 100
epss top --limit 100 --order !epss
# Above thresholds
epss query --epss-gt 0.95
epss query --percentile-gt 0.95
# Specific date
epss get CVE-2022-26332 --date 2022-03-05
# Output formats
epss query --limit 5 --format json
epss query --limit 5 --format csv > out.csv
```
## API coverage
This client wraps `https://api.first.org/data/v1/epss` including:
- single and batch CVE queries
- pagination with `offset` and `limit`
- filters: `date`, `scope=time-series`, `order`, `epss-gt`, `percentile-gt`
- optional `envelope` and `pretty`
See the official docs: `https://api.first.org/epss`.
## License
MIT