vt3 0.5.4

VirusTotal REST API v3 (Public & Enterprise)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

# VirusTotal Api v3 (Public & Enterprise)
![Crates.io](https://img.shields.io/crates/v/vt3)
[![Documentation](https://docs.rs/vt3/badge.svg)](https://docs.rs/vt3)
![docs.rs](https://img.shields.io/docsrs/vt3/latest)
[![Build Status](https://travis-ci.com/marirs/vt3-rs.svg?branch=main)](https://travis-ci.com/marirs/vt3-rs)
[![GitHub license](https://img.shields.io/github/license/marirs/vt3-rs)](https://github.com/marirs/vt3-rs/blob/main/LICENSE)

VT3 provides an easy api interface to use VirusTotal v3 REST endpoints, 
including those exclusive to VirusTotal Enterprise such as 
- Live Hunt
- Retro Hunt 
- Zip Files 

## Usage
- Cargo.toml
```toml
[dependencies]
vt3 = "0.5.4"
```

- to enable enterprise features
```toml
[dependencies]
vt3 = { version = "0.5.4", features = ["enterprise"] }
```

- and then: to get `ip information`
```rust
use vt3::VtClient;

fn main() {
    let api_key = match std::env::args()
        .skip(1)
        .next()
        .ok_or_else(|| "Please provide the api key!")
    {
        Ok(api_key) => api_key,
        Err(e) => {
            println!("{:?}", e);
            std::process::exit(1)
        }
    };
    let ip_address = "5.2.69.42";

    let res = VtClient::new(&api_key).ip_info(ip_address);
    match res {
        Ok(report) => println!("{:#?}", report),
        Err(e) => println!("Error: {}", e.to_string()),
    }
}
```
- Providing a `user agent` for the client

```rust
use vt3::VtClient;

fn main() {
    let api_key = match std::env::args()
        .skip(1)
        .next()
        .ok_or_else(|| "Please provide the api key!")
    {
        Ok(api_key) => api_key,
        Err(e) => {
            println!("{:?}", e);
            std::process::exit(1)
        }
    };
    let ip_address = "5.2.69.42";

    let res = VtClient::new(&api_key)
        .user_agent("Chrome for Windows")
        .ip_info(ip_address);
    match res {
        Ok(report) => println!("{:#?}", report),
        Err(e) => println!("Error: {}", e.to_string()),
    }
}
```

## Examples
To run the examples - `Universal API Endpoints`:
- Domain info: `cargo run --example domain_info <your_api_key>`
- IP info: `cargo run --example ip_info <your_api_key>`
- URL info: `cargo run --example url_info <your_api_key>`
- URL info by id: `cargo run --example url_info_by_id <your_api_key>`
- URL rescan: `cargo run --example url_rescan <your_api_key>`
- File info: `cargo run --example file_info <your_api_key>`
- File scan: `cargo run --example file_scan <your_api_key>`
- File rescan: `cargo run --example file_rescan <your_api_key>`
- Get latest comments: `cargo run --example get_latest_comments <your_api_key>`
- Get comment by comment id: `cargo run --example get_comment <your_api_key>`

To run the examples - `Enterprise API Endpoints`:
- Get user information: `cargo run --example user_info --features="enterprise" <your_api_key> <user_id>`
- Delete a user: `cargo run --example delete_user --features="enterprise" <your_api_key> <user_id>`
- Get Api usage info: `cargo run --example api_usage --features="enterprise" <your_api_key> <user_id>`
- Get overall quotas for user: `cargo run --example overall_quotas --features="enterprise" <your_api_key> <user_id>`
- Get group information: `cargo run --example group_info --features="enterprise" <your_api_key> <user_id>`
- Get api usage: `cargo run --example group_api_usage --features="enterprise" <your_api_key> <user_id>`
- Get group members: `cargo run --example group_members --features="enterprise" <your_api_key> <user_id>`

## VT Developer reference

- https://developers.virustotal.com/v3.0/reference

---
License: MIT