Metadata-Version: 2.1
Name: vt_graph_api
Version: 2.2.0
Summary: The official Python client library for VirusTotal Graph API
Home-page: https://github.com/virustotal/vt-graph-api
Author: VirusTotal
Author-email: vt_graph_api@virustotal.com
License: Apache 2
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE.md

![Tests](https://github.com/VirusTotal/vt-graph-api/actions/workflows/tests.yaml/badge.svg)

# VirusTotal Graph API

VirusTotal Graph API allows you programatically interact with VirusTotal dataset.

## Installing the API
Install VirusTotal Graph Python API.
```
git clone https://github.com/VirusTotal/vt_graph_api
cd vt_graph_api
pip install . --user
```

## Verifying the installation

```python
>>> import vt_graph_api
>>> vt_graph_api.__version__
X.X.X
```

## Documentation

For more information about how to use **vt_graph_api** visit the [documentation](https://virustotal.github.io/vt-graph-api/) page.

You may also want to take a look at some of our [example scripts](https://github.com/VirusTotal/vt-graph-api/tree/master/examples),
which besides doing useful work for you can be used as a guidance on how to use **vt_graph_api**.

In addition, you can find the documentation for the VirusTotal Graph REST API at the [API reference](https://developers.virustotal.com/v3.0/reference#graphs)

# Test it!

Use tox to test:

```
>>> tox
```

# Changelog

### V2.2.0
- Support for loading Graphs with special relationships (Groups, Intelligence, Livehunt, Retrohunt, Commonalities).
- New method for creating groups of nodes.

### V2.1.0
- Support for setting Graph representation.

### V2.0.0
- Removed `carbonblack_children` and `carbonblack_parent` relationships in File entity.
- Create a Collection from a Graph.
- Added **new entity** types:
  - collection
  - reference
  - whois
  - ssl_cert
- Added **new relationships**:
  - Files: *dropped_files, collections, email_attachments, itw_ips, overlay_children, pe_resource_children, references, urls_for_embedded_js*
  - Domains: *historical_ssl_certificates,
    historical_whois,
    caa_records,
    cname_records,
    mx_records,
    ns_records,
    soa_records,
    collections,
    references.*
  - IP Addresses: *historical_ssl_certificates,
    historical_whois,
    collections,
    references.*
  - Urls: *contacted_domains,
    contacted_ips,
    redirects_to,
    urls_related_by_tracker_id,
    communicating_files,
    referrer_files,
    embedded_js_files,
    collections,
    references*
  - Collections: *files,
    domains,
    ip_addresses,
    urls,
    references.*
  - Whois: *network_location.*

### V1.1.3
- Bug fixing.

### V1.1.2
- Bug fixing.

### V1.1.1
- Bug fixing.
- Fixing documentation.

### V1.1.0
- Added download graph screenshot from VirusTotal.

### V1.0.1
- Fixing documentation.

### V1.0.0
---
- Added autosearch algorithm to find links between graph's nodes.
- Accept **MD5** and **SHA1** as valid ID for nodes with **file type**.
- Added **VTIntelligence** search for nodes without any information.
- Accept custom node types.
- Added load graph from VirusTotal.
- Added clone graph from VirusTotal.
