VirusTotal API
Project description
VirusTotal API 3 version
The module that implements the service API functions www.virustotal.com (3 versions). For a detailed description of the API, see: https://developers.virustotal.com/v3.0/reference.
The following VirusTotal API functions are implemented:
For files:
/files
/files/upload_url
/files/{id}
/files/{id}/analyse
/files/{id}/comments
/files/{id}/comments
/files/{id}/votes
/files/{id}/votes
/files/{id}/{relationship}
/file_behaviours/{sandbox_id}/pcap
/files/{id}/download_url (Added in version 1.2.0, requires a private key to access API functions)
/files/{id}/download (Added in version 1.2.0, requires a private key to access API functions)
For URLs:
/urls
/urls/{id}
/urls/{id}/analyse
/urls/{id}/comments
/urls/{id}/comments
/urls/{id}/votes
/urls/{id}/votes
/urls/{id}/network_location
For domains:
/domains/{domain}
/domains/{domain}/comments
/domains/{domain}/comments
/domains/{domain}/{relationship}
/domains/{domain}/votes
/domains/{domain}/votes
For IP-addresses:
/domains/{domain}
/domains/{domain}/comments
/domains/{domain}/comments
/domains/{domain}/{relationship}
/domains/{domain}/votes
/domains/{domain}/votes
File and URL analysis:
/analyses/{id}
Installation
pip install vtapi3
Usage
In python programs
Code
import json
from vtapi3 import VirusTotalAPIFiles, VirusTotalAPIError
...
vt_files = VirusTotalAPIFiles('<API key>')
try:
result = vt_files.upload('<file path>')
except VirusTotalAPIError as err:
print(err, err.err_code)
else:
if vt_files.get_last_http_error() == vt_files.HTTP_OK:
result = json.loads(result)
result = json.dumps(result, sort_keys=False, indent=4)
print(result)
else:
print('HTTP Error [' + str(vt_files.get_last_http_error()) +']')
...
Output
{
"data": {
"type": "analysis",
"id": "NjY0MjRlOTFjMDIyYTkyNWM0NjU2NWQzYWNlMzFmZmI6MTQ3NTA0ODI3Nw=="
}
}
From command line (added in version 1.1.0)
Before using the package from the command line, you must create an environment variable VT_API_KEY in which to place the value of the access key to the VirusTotal API functions.
python -m vtapi3 [-h] [-fid] [-fsr] [-far] [-hr] [-uid] [-usr] [-uar] [-ipr] [-dr] resource
Positional arguments
resource - Object that you want to analyse in VirusTotal (file, URL, IP address or domain).
Optional arguments
-h, --help - Show help message and exit.
-fid, --file-id - Getting the identifier of the file for further analysis.
-fsr, --file-scan-report - Getting a report on the results of scanning a file.
-far, --file-analyse-report - Getting a report on the results of file analysis (enabled by default).
-hr, --hash-report - Getting a report on the results of analyzing a file by its hash (SHA256, SHA1 or MD5).
-uid, --url-id - Getting the identifier of the URL for further analysis.
-usr, --url-scan-report - Getting a report on the results of scanning a URL.
-uar, --url-analyse-report - Getting a report on the results of URL analysis.
-ipr, --ip-report - Getting a report on the results of IP address analysis.
-dr, --domain-report - Getting a report on the results of domain analysis.
License
MIT Copyright (c) 2020 Evgeny Drobotun
Documentation
Documentation for using this package: https://virustotalapi3.readthedocs.io
Release History
1.2.1 (10.04.2020)
Fixed several bugs
Сhanged the structure and composition of tests (the value of code coverage by tests is 99%).
1.2.0 (11.02.2020)
Сhanged the structure of files and directories of the module.
Added the get_download_url() and get_download() functions (VirusTotalAPIFiles class).
The main() function was refactored in __main__.py.
Сhanged the structure and composition (added tests for checking functions when the “Connection Error” error occurs) of tests (the value of code coverage by tests is 93%).
1.1.3 (7.02.2020)
Fixed several bugs in __main__.ru
1.1.2 (5.02.2020)
Fixed __init__.py (to ensure correct implementation of import).
Added __main__.py (to improve the command line experience).
1.1.1 (4.02.2020)
Fixed several errors in the get_file_id_to_analyse() and get_url_id_to_analyse functions().
Added VirusTotalAPIError(IO Error) exception in the get_file_id() and upload() functions of the VirusTotalAPIFiles class.
1.1.0 (3.02.2020)
Added the ability to performance the package from the command line.
1.0.4 (1.02.2020)
Fixing README.rst for better PYPI presentation.
1.0.3 (26.01.2020)
Added a new attribute _last_result to the VirustotalAPI base class.
Added a new method get_last_result to the VirustotalAPI base class.
1.0.2 (12.01.2020)
Fixed errors in source comments.
Fixing README.rst for better PYPI presentation.
Fixing setup.py for better PYPI presentation.
README.rst translated into English.
Added two tests (test_get_version_avi() and test_get_lost_http_error ()) in test_vt_3.py
1.0.1 (08.01.2020)
First release of vtapi3
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.