https://github.com/bradsec/vtlookup

Python3 VirusTotal API v3 File Hash Lookup
https://github.com/bradsec/vtlookup

python python-3 python3 virustotal virustotal-api virustotal-python virustotal-search

Last synced: about 1 month ago
JSON representation

Python3 VirusTotal API v3 File Hash Lookup

• Host: GitHub
• URL: https://github.com/bradsec/vtlookup
• Owner: bradsec
• License: mit
• Created: 2021-12-12T08:02:40.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-12T09:42:08.000Z (about 3 years ago)
• Last Synced: 2024-11-10T13:12:07.383Z (3 months ago)
• Topics: python, python-3, python3, virustotal, virustotal-api, virustotal-python, virustotal-search
• Language: Python
• Homepage:
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Python3 VirusTotal API v3 File Hash Lookup

### Getting started  

**Prerequisite:** A VirusTotal API key is required and must be set as an environment variable with a name of `VT_API_KEY`. Get a free public API key by completing the signup at https://www.virustotal.com/gui/join-us.

1. Download or clone the `vtlookup` repository  

`git clone https://github.com/bradsec/vtlookup.git`

2. Set the `VT_API_KEY` environment variable:

For Linux users -

```

VT_API_KEY="YOUR_VIRUSTOTAL_APIKEY"

export VT_API_KEY

```

For Windows users -

```

setx VT_API_KEY "YOUR_VIRUSTOTAL_APIKEY"

```

### Usage examples (running from terminal)

- Lookup using plain text hash *(hashValue can be md5, sha1, or sha256)*  -  

`python3 vtlookup.py -hash hashValue`  

*The below example will return detections:*  

`python3 vtlookup.py -hash a2f6b977b849ba588b88c81b68b4535c`  

- Lookup by getting the sha256 hash from a local file -  

`python3 vtlookup.py -file specifyfilename.ext`

- Offline debug using the included `test.json` file -  

`python3 vtlookup.py -debug test.json`

### Troubleshooting

API error code descriptions can be found at: https://developers.virustotal.com/reference/errors