https://github.com/maxmmueller/virustotalpy

A python wrapper for an easier interaction with the VirusTotal v3 api
https://github.com/maxmmueller/virustotalpy

maleware-analysis python python3 virus-scanning virustotal-api virustotal-python wrapper

Last synced: about 2 months ago
JSON representation

A python wrapper for an easier interaction with the VirusTotal v3 api

• Host: GitHub
• URL: https://github.com/maxmmueller/virustotalpy
• Owner: maxmmueller
• License: apache-2.0
• Created: 2021-12-30T21:48:36.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-17T11:57:39.000Z (over 1 year ago)
• Last Synced: 2024-11-07T03:18:49.719Z (about 2 months ago)
• Topics: maleware-analysis, python, python3, virus-scanning, virustotal-api, virustotal-python, wrapper
• Language: Python
• Homepage:
• Size: 66.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        








VirusTotalPy











Open-source Python library for an easier interaction with the VirusTotal v3 API


## Features

The latest Version 1.0.1 lets you analyse and scan a list of IPs, URLs and files up to 650MB.

## Installation

##### Method 1:



```

pip install virustotalpy

```

##### Method 2:

 

```

git clone https://github.com/maxmmueller/virustotalpy.git

```

##### Method 3:

Download the [latest Release](https://github.com/maxmmueller/virustotalpy/releases/latest)

## Usage

In order to use the API you need to [sign up](https://www.virustotal.com/gui/join-us) for a VirusTotal account and create an API key.

>

> ![View API key](https://raw.githubusercontent.com/maxmmueller/virustotalpy/master/imgs/api_key.jpeg)

Code example:

```python

from virustotalpy import Scanner

# replace this with your actual api key and username

API_KEY = "YOUR-API-KEY"

USER_NAME = "YOUR-VIRUSTOTAL-USERNAME"

scanner = Scanner(API_KEY, USER_NAME)

data = [

    "https://www.example.com",

    "192.168.0.1",

    "test.exe"

]

result = scanner.scan(data)

print(result)

```

## Learn more

- [Documentation and reference](https://github.com/maxmmueller/virustotalpy/blob/main/docs/docs.md)

- [PyPI](https://pypi.org/project/virustotalpy)

- [API reference](https://developers.virustotal.com/reference/overview)

## Contributing

Contributions to this project are welcome!

If you encounter any problems, find a bug or have feature requests, please open an [issue](https://github.com/maxmmueller/virustotalpy/issues/new).

## Licence

Maximilian Müller 2021-2023

[Apache License 2.0](LICENSE)