NAV
Shell Python

Introduction

Welcome to the Vysion API! You can use our API to access Vysion API endpoints, which can give you Threat Intelligence Information from our database.

We have language bindings in Shell, Python and a MISP module! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

Each request must contain the header x-api-key:

# With curl, you can just pass the correct header with each request
curl "https://api.vysion.ai" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client

c = client.Client(api_key=API_KEY)

Make sure to replace API_KEY with your API key.

Vysion uses API keys to allow access to the API.

Vysion expects for the API key to be included in all API requests to the server in a header that looks like the following:

x-api-key: API_KEY

Documents

Vysion integrates multiple Threat Intelligence sources, accessible via the document endpoints, enabling comprehensive search capabilities.

Search for documents

# With curl, you can just pass the correct header with each request
curl "https://api.vysion.ai/api/v2/document/search?q=contileaks&page=1" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client 

c = client.Client(api_key=API_KEY)

result = c.search("contileaks")

for hit in result.hits:
  print(hit)

GET /api/v2/document/search

Vysion API allows several types of searches. The default one is keyword search query that allow the usage of "Google Dork" sintax.

Supporing the following operators:

Parameters

Name In Type Required Description
q query string true none
gte query string false none
lte query string false none
page query integer false none
page_size query integer false Default size is 10
network query string false Filter by Tor, I2P or Clearnet
language query string false none
include_tag query string false none
exclude_tag query string false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "email": [
          {
            "value": "string"
          }
        ],
        "paste": [
          {
            "value": "string"
          }
        ],
        "skype": [
          {
            "value": "string"
          }
        ],
        "telegram": [
          {
            "value": "string"
          }
        ],
        "whatsapp": [
          {
            "value": "string"
          }
        ],
        "bitcoin_address": [
          {
            "value": "string"
          }
        ],
        "polkadot_address": [
          {
            "value": "string"
          }
        ],
        "ethereum_address": [
          {
            "value": "string"
          }
        ],
        "monero_address": [
          {
            "value": "string"
          }
        ],
        "ripple_address": [
          {
            "value": "string"
          }
        ],
        "zcash_address": [
          {
            "value": "string"
          }
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_DocumentHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get a document by ID

Code samples

curl "https://api.vysion.ai/api/v2/document/62bdc0968e4892b70411895c" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client 

c = client.Client(api_key=API_KEY)

result = c.get_document("62bdc0968e4892b70411895c")

print(result)

This endpoint retrieves a specific document from Vysion database base on its ID.

HTTP Request

GET /api/v2/document/{id}

Parameters

Name In Type Required Description
id path string true Document ID

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "email": [
          {
            "value": "string"
          }
        ],
        "paste": [
          {
            "value": "string"
          }
        ],
        "skype": [
          {
            "value": "string"
          }
        ],
        "telegram": [
          {
            "value": "string"
          }
        ],
        "whatsapp": [
          {
            "value": "string"
          }
        ],
        "bitcoin_address": [
          {
            "value": "string"
          }
        ],
        "polkadot_address": [
          {
            "value": "string"
          }
        ],
        "ethereum_address": [
          {
            "value": "string"
          }
        ],
        "monero_address": [
          {
            "value": "string"
          }
        ],
        "ripple_address": [
          {
            "value": "string"
          }
        ],
        "zcash_address": [
          {
            "value": "string"
          }
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_DocumentHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get a document by URL

Code samples

curl "https://api.vysion.ai/api/v2/document/url/7szmmmqckjag4tstn2qv5icavm3gj2654yjl2v25d6oto55m2sykn3yd.onion%2FContiLeaks%2F?page=1" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client 

c = client.Client(api_key=API_KEY)

result = c.find_url("7szmmmqckjag4tstn2qv5icavm3gj2654yjl2v25d6oto55m2sykn3yd.onion/ContiLeaks/")

for hit in result.hits:
  print(hit)

This endpoint fetches specific documents from the Vysion database based on their URLs. The number of documents retrieved depends on the quantity of captures available.

HTTP Request

GET /api/v2/document/url/{url}

Parameters

Name In Type Required Description
url path string true none
gte query string false none
lte query string false none
page query integer false Default size is 10
page_size query integer false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "email": [
          {
            "value": "string"
          }
        ],
        "paste": [
          {
            "value": "string"
          }
        ],
        "skype": [
          {
            "value": "string"
          }
        ],
        "telegram": [
          {
            "value": "string"
          }
        ],
        "whatsapp": [
          {
            "value": "string"
          }
        ],
        "bitcoin_address": [
          {
            "value": "string"
          }
        ],
        "polkadot_address": [
          {
            "value": "string"
          }
        ],
        "ethereum_address": [
          {
            "value": "string"
          }
        ],
        "monero_address": [
          {
            "value": "string"
          }
        ],
        "ripple_address": [
          {
            "value": "string"
          }
        ],
        "zcash_address": [
          {
            "value": "string"
          }
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_DocumentHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get documents by tag

Code samples

curl "https://api.vysion.ai/api/v2/document/tag/dark-web%3Atopic%3D%22hacking%22?page=1" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client 

c = client.Client(api_key=API_KEY)

result = c.find_url("dark-web:topic=\"hacking\"")

for hit in result.hits:
  print(hit)

The content within Vysion platform is automatically categorized. Users can filter content by tags using keyword search, or alternatively, access a dedicated endpoint for tags without specifying any keywords.

Rigth now the following dark-web topics are available:

namespace predicate value
dark-web topic credit-card
dark-web topic drugs-narcotics
dark-web topic electronics
dark-web topic escrow
dark-web topic finance
dark-web topic finance-crypto
dark-web topic gambling
dark-web topic hacking
dark-web topic identification-credentials
dark-web topic intellectual-property-copyright-materials
dark-web topic mixer
dark-web topic pornography-adult
dark-web topic pornography-child-exploitation
dark-web topic pornography-illicit-or-illegal
dark-web topic search-engine-index
dark-web topic softwares
dark-web topic weapons
dark-web topic ransomware-group

HTTP Request

GET /api/v2/document/tag/{tag}

Parameters

Name In Type Required Description
tag path string true none
gte query string false none
lte query string false none
page query integer false none
page_size query integer false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "email": [
          {
            "value": "string"
          }
        ],
        "paste": [
          {
            "value": "string"
          }
        ],
        "skype": [
          {
            "value": "string"
          }
        ],
        "telegram": [
          {
            "value": "string"
          }
        ],
        "whatsapp": [
          {
            "value": "string"
          }
        ],
        "bitcoin_address": [
          {
            "value": "string"
          }
        ],
        "polkadot_address": [
          {
            "value": "string"
          }
        ],
        "ethereum_address": [
          {
            "value": "string"
          }
        ],
        "monero_address": [
          {
            "value": "string"
          }
        ],
        "ripple_address": [
          {
            "value": "string"
          }
        ],
        "zcash_address": [
          {
            "value": "string"
          }
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_DocumentHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get documents by wallet, supports BTC, BNB, DOT, DASH, ETH, XMR, XRP & ZEC

Code samples

curl "https://api.vysion.ai/api/v2/document/wallet/BTC/114qvtyucvKtiNXy9UL3eYx6HPYmadxeM4" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client 

c = client.Client(api_key=API_KEY)
result = c.find_wallet("BTC", "114qvtyucvKtiNXy9UL3eYx6HPYmadxeM4")

for hit in result.hits:
  print(hit)

Vysion supports searching for multiple cryptocurrency wallets within its database. If a match is found, the corresponding document or documents containing the wallet information will be returned.

HTTP Request

GET /api/v2/document/wallet/{chain}/{address}

Parameters

Name In Type Required Description
chain path string true Before conducting a search, it is necessary to specify the blockchain type to search within.
address path string true none
gte query string false none
lte query string false none
page query integer false none
page_size query integer false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "email": [
          {
            "value": "string"
          }
        ],
        "paste": [
          {
            "value": "string"
          }
        ],
        "skype": [
          {
            "value": "string"
          }
        ],
        "telegram": [
          {
            "value": "string"
          }
        ],
        "whatsapp": [
          {
            "value": "string"
          }
        ],
        "bitcoin_address": [
          {
            "value": "string"
          }
        ],
        "polkadot_address": [
          {
            "value": "string"
          }
        ],
        "ethereum_address": [
          {
            "value": "string"
          }
        ],
        "monero_address": [
          {
            "value": "string"
          }
        ],
        "ripple_address": [
          {
            "value": "string"
          }
        ],
        "zcash_address": [
          {
            "value": "string"
          }
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_DocumentHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get documents by email

Code samples

curl "https://api.vysion.ai/api/v2/document/email/someonedeep@dnmx.org" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client 

c = client.Client(api_key=API_KEY)
result = c.find_email("someonedeep@dnmx.org")

for hit in result.hits:
  print(hit)

Vysion supports searching for email addresses within its database. If a match is found, the corresponding document or documents containing the wallet information will be returned.

HTTP Request

GET /api/v2/document/email/{email}

Parameters

Name In Type Required Description
email path string true none
gte query string false none
lte query string false none
page query integer false none
page_size query integer false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "email": [
          {
            "value": "string"
          }
        ],
        "paste": [
          {
            "value": "string"
          }
        ],
        "skype": [
          {
            "value": "string"
          }
        ],
        "telegram": [
          {
            "value": "string"
          }
        ],
        "whatsapp": [
          {
            "value": "string"
          }
        ],
        "bitcoin_address": [
          {
            "value": "string"
          }
        ],
        "polkadot_address": [
          {
            "value": "string"
          }
        ],
        "ethereum_address": [
          {
            "value": "string"
          }
        ],
        "monero_address": [
          {
            "value": "string"
          }
        ],
        "ripple_address": [
          {
            "value": "string"
          }
        ],
        "zcash_address": [
          {
            "value": "string"
          }
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_DocumentHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get documents by phone number

Search by mobile phones is also possible. If a match is found, the corresponding document or documents containing the wallet information will be returned.

Code samples

curl "https://api.vysion.ai/api/v2/document/1/200080426" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client 

country_code = "1"
phone = "200080426" 
c = client.Client(api_key=API_KEY)
result = c.find_phone(country_code, phone)

for hit in result.hits:
  print(hit)

HTTP Request

GET /api/v2/document/phone/{country_code}/{number}

Parameters

Name In Type Required Description
country_code path string true none
number path string true none
gte query string false none
lte query string false none
page query integer false none
page_size query integer false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "email": [
          {
            "value": "string"
          }
        ],
        "paste": [
          {
            "value": "string"
          }
        ],
        "skype": [
          {
            "value": "string"
          }
        ],
        "telegram": [
          {
            "value": "string"
          }
        ],
        "whatsapp": [
          {
            "value": "string"
          }
        ],
        "bitcoin_address": [
          {
            "value": "string"
          }
        ],
        "polkadot_address": [
          {
            "value": "string"
          }
        ],
        "ethereum_address": [
          {
            "value": "string"
          }
        ],
        "monero_address": [
          {
            "value": "string"
          }
        ],
        "ripple_address": [
          {
            "value": "string"
          }
        ],
        "zcash_address": [
          {
            "value": "string"
          }
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_DocumentHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Document HTML

Get the HTML content of a darknet document.

Get a document's HTML by ID

Code samples

curl "https://api.vysion.ai/api/v2/html/62bdc0968e4892b70411895c" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client 

c = client.Client(api_key=API_KEY)
result = c.get_document_html("62bdc0968e4892b70411895c")

print(result)

HTTP Request

GET /api/v2/html/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

Ransomware Victims

Get ransomware victims from the Vysion database.

Search for ransomware victims

Code samples

curl "https://api.vysion.ai/api/v2/victim/search?q=american&page=1" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client 

c = client.Client(api_key=API_KEY)
result = c.search_ransomware_victim("american")

for hit in result:
  print(result)

Vysion also monitors ransomware activity on the darknet, providing the capability to specifically search for detected victims.

HTTP Request

GET /api/v2/victim/search

Parameters

Name In Type Required Description
gte query string false none
lte query string false none
page query integer false none
page_size query integer false none
q query string false none
network query string false none
country query string false none
language query string false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "ransomwareGroup": "string",
        "companyName": "string",
        "companyAddress": "string",
        "companyLink": "string",
        "country": "string"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_RansomwareHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get a ransomware victim by ID

Code samples

curl "https://api.vysion.ai/api/v2/victim/64abc305e7f72075c8b582c2" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

from vysion import client 

c = client.Client(api_key=API_KEY)
result = c.get_ransomware_victim("64abc305e7f72075c8b582c2")

print(result)

HTTP Request

GET /api/v2/victim/{id}

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "ransomwareGroup": "string",
        "companyName": "string",
        "companyAddress": "string",
        "companyLink": "string",
        "country": "string"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_RansomwareHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Ransomware Stats

Get ransomware statistics for a given time range and filters.

Get ransomware stats by country

Code samples

curl "https://api.vysion.ai/api/v2/stats/countries?countries=ES,FR" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

import requests

headers = {
  'Accept': 'application/json',
  'x-api-key': API_KEY,
}

countries = "ES, FR" 

r = requests.get('https://api.vysion.ai/api/v2/stats/countries/' + countries , headers = headers)

print(r.json())

GET /api/v2/stats/countries

Parameters

Name In Type Required Description
countries query string false Country list following ISO 3166-1 alpha-2 codes (i.e. UK, FR, ES)
gte query string false none
lte query string false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "key": "string",
        "doc_count": 0
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Retrieve statistics on the number of attacks detected against different countries.

HTTP Request

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_Stat_
422 Unprocessable Entity Validation Error HTTPValidationError

Get ransomware stats by group

Code samples

curl "https://api.vysion.ai/api/v2/stats/groups" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

import requests

headers = {
  'Accept': 'application/json',
  'x-api-key': API_KEY,
}

r = requests.get('https://api.vysion.ai/api/v2/stats/groups', headers = headers)

print(r.json())

Retrieve statistics on the number of attacks performed by different ransomware groups.

HTTP Request

GET /api/v2/stats/groups

Parameters

Name In Type Required Description
countries query string false Country list following ISO 3166-1 alpha-2 codes (i.e. UK, FR, ES)
gte query string false none
lte query string false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "key": "string",
        "doc_count": 0
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_Stat_
422 Unprocessable Entity Validation Error HTTPValidationError

Ransomware Histograms

Get ransomware histograms for attacks and groups

Get the ransomware attacks histogram

Code samples

curl "https://api.vysion.ai/api/v2/histogram/attacks" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

import requests

headers = {
  'Accept': 'application/json',
  'x-api-key': API_KEY,
}

r = requests.get('https://api.vysion.ai/api/v2/histogram/attacks', headers = headers)

print(r.json())

Retrieve statistics on the number of attacks per month.

HTTP Request

GET /api/v2/histogram/attacks

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "key": "string",
        "doc_count": 0,
        "key_as_string": "string",
        "agg": {
          "buckets": [
            {
              "key": "string",
              "doc_count": 0
            }
          ]
        }
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_AggStats_

Get the ransomware groups histogram

Code samples

curl "https://api.vysion.ai/api/v2/histogram/groups" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

import requests

headers = {
  'Accept': 'application/json',
  'x-api-key': API_KEY,
}

r = requests.get('https://api.vysion.ai/api/v2/histogram/groups', headers = headers)

print(r.json())

Retrieve statistics on the number of attacks per ransomware groups and month.

HTTP Request

GET /api/v2/histogram/groups

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "key": "string",
        "doc_count": 0,
        "key_as_string": "string",
        "agg": {
          "buckets": [
            {
              "key": "string",
              "doc_count": 0
            }
          ]
        }
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_AggStats_

Instant Messaging

Get information about instant messaging platforms. Currently supports Telegram.

Search for IM messages

Code samples

curl "https://api.vysion.ai/api/v2/im/Telegram/search?q=ak47" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'


from vysion import client 

c = client.Client(api_key=config.API_KEY)
result = c.search_im("Telegram", "ak47")

for hit in result:
  print(hit)

Search for IM messages.

HTTP Request

GET /api/v2/im/{platform}/search

Parameters

Name In Type Required Description
platform path string true Telegram
gte query string false none
lte query string false none
page query integer false none
page_size query integer false none
q query string true none
username query string false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "userId": 0,
        "username": "string",
        "channelId": 0,
        "messageId": "string",
        "message": "string",
        "channelTitle": "string",
        "languages": [
          {
            "language": "string",
            "probability": 0
          }
        ],
        "sha1sum": "string",
        "sha256sum": "string",
        "media": "string",
        "detectionDate": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_ImMessageHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get IM chat by channel ID

Code samples

curl "https://api.vysion.ai/api/v2/im/Telegram/chat/-1002018436281" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'


from vysion import client 

c = client.Client(api_key=config.API_KEY)

result = c.get_im_chat("Telegram", "-1001018336281", gte="2024-05-16T10:57:58.632466", lte="2024-05-16T23:00:00")

print(result)

Get messages from a group given a channelId.

HTTP Request

GET /api/v2/im/{platform}/chat/{channelId}

Parameters

Name In Type Required Description
platform path string true none
channelId path string true none
gte query string false none
lte query string false none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "userId": 0,
        "username": "string",
        "channelId": 0,
        "messageId": "string",
        "message": "string",
        "channelTitle": "string",
        "languages": [
          {
            "language": "string",
            "probability": 0
          }
        ],
        "sha1sum": "string",
        "sha256sum": "string",
        "media": "string",
        "detectionDate": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_ImMessageHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get IM profile by user ID

Code samples

curl "https://api.vysion.ai/api/v2/im/Telegram/profile/1595126601" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'


from vysion import client 

c = client.Client(api_key=config.API_KEY)
result = c.get_im_profile("Telegram", "1595116601")

print(result)

Get information from an user.

HTTP Request

GET /api/v2/im/{platform}/profile/{userId}

Parameters

Name In Type Required Description
platform path string true none
userId path string true none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "userId": 0,
        "usernames": [
          "string"
        ],
        "firstName": [
          "string"
        ],
        "lastName": [
          "string"
        ],
        "detectionDate": "2019-08-24T14:15:22Z",
        "profilePhoto": [
          "string"
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_ImProfileHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get IM message by message ID

Code samples

curl "https://api.vysion.ai/api/v2/im/Telegram/message/-1012018336281_85" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'


from vysion import client 

c = client.Client(api_key=config.API_KEY)
result = c.get_im_message("Telegram", "-1002018336281_85")

print(result)

Get information details of an specific message.

HTTP Request

GET /api/v2/im/{platform}/message/{messageId}

Parameters

Name In Type Required Description
platform path string true none
messageId path string true none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "userId": 0,
        "username": "string",
        "channelId": 0,
        "messageId": "string",
        "message": "string",
        "channelTitle": "string",
        "languages": [
          {
            "language": "string",
            "probability": 0
          }
        ],
        "sha1sum": "string",
        "sha256sum": "string",
        "media": "string",
        "detectionDate": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_ImMessageHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get channel info by channel ID

Code samples

curl "https://api.vysion.ai/api/v2/im/Telegram/channel/-1012018336281" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'


from vysion import client 

c = client.Client(api_key=config.API_KEY)
result = c.get_im_channel("Telegram", "-1012018336281")

print(result)

Get information details of an specific channel.

HTTP Request

GET /api/v2/im/{platform}/channel/{channelId}

Parameters

Name In Type Required Description
platform path string true none
channelId path string true none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "channelId": 0,
        "channelTitles": [
          "string"
        ],
        "detectionDate": "2019-08-24T14:15:22Z",
        "creationDate": "2019-08-24T14:15:22Z",
        "channelPhoto": [
          "string"
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_ImChannelHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Feed

CTI Information Feeds

Get ransomware feed

Code samples

curl "https://api.vysion.ai/api/v2/feed/ransomware?batch=2024-08-01" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/feed/ransomware', params={
  'batch': 'string'
}, headers = headers)

print(r.json())

Daily feed of ransomware victims.

HTTP Request

GET /api/v2/feed/ransomware

Parameters

Name In Type Required Description
page query integer false none
page_size query integer false none
batch query string true none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "id": "string",
        "companyName": "string",
        "companyLink": "string",
        "url": "string",
        "ransomwareGroup": "string",
        "detectionDate": "2019-08-24T14:15:22Z",
        "text": "string",
        "country": "string"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_RansomFeedHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Get Telegram feed

Code samples

curl "https://api.vysion.ai/api/v2/feed/telegram?batch=2024-08-01" \
  --header 'Accept: application/json' \
  --header 'x-api-key: API_KEY'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/feed/telegram', params={
  'batch': 'string'
}, headers = headers)

print(r.json())

Daily feed of detected telegram channels detected by Vysion.

HTTP Request

GET /api/v2/feed/telegram

Parameters

Name In Type Required Description
page query integer false none
page_size query integer false none
batch query string true none

Example responses

200 Response

{
  "data": {
    "total": 0,
    "hits": [
      {
        "id": "string",
        "telegram": [
          "string"
        ],
        "detectionDate": "2019-08-24T14:15:22Z",
        "url": "string",
        "path": "string",
        "network": "string"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Response VysionResponse_ImFeedHit_
422 Unprocessable Entity Validation Error HTTPValidationError

Response Schema

Schemas

AggStats

{
  "key": "string",
  "doc_count": 0,
  "key_as_string": "string",
  "agg": {
    "buckets": [
      {
        "key": "string",
        "doc_count": 0
      }
    ]
  }
}

AggStats

Properties

Name Type Required Restrictions Description
key any true none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous integer false none none

continued

Name Type Required Restrictions Description
doc_count integer true none none
key_as_string string true none none
agg Buckets true none none

BitcoinAddress

{
  "value": "string"
}

BitcoinAddress

Properties

Name Type Required Restrictions Description
value string true none none

Buckets

{
  "buckets": [
    {
      "key": "string",
      "doc_count": 0
    }
  ]
}

Buckets

Properties

Name Type Required Restrictions Description
buckets [Stat] true none none

DocumentHit

{
  "page": {
    "id": "string",
    "url": {
      "url": "string",
      "networkProtocol": "string",
      "domainName": "string",
      "port": 0,
      "path": "string",
      "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
      "network": "tor"
    },
    "foundAt": "string",
    "pageTitle": "string",
    "language": "av",
    "html": "string",
    "text": "string",
    "sha1sum": "string",
    "sha256sum": "string",
    "ssdeep": "string",
    "detectionDate": "2019-08-24T14:15:22Z",
    "chunk": false
  },
  "tag": [
    {
      "namespace": "string",
      "predicate": "string",
      "value": "string"
    }
  ],
  "email": [
    {
      "value": "string"
    }
  ],
  "paste": [
    {
      "value": "string"
    }
  ],
  "skype": [
    {
      "value": "string"
    }
  ],
  "telegram": [
    {
      "value": "string"
    }
  ],
  "whatsapp": [
    {
      "value": "string"
    }
  ],
  "bitcoin_address": [
    {
      "value": "string"
    }
  ],
  "polkadot_address": [
    {
      "value": "string"
    }
  ],
  "ethereum_address": [
    {
      "value": "string"
    }
  ],
  "monero_address": [
    {
      "value": "string"
    }
  ],
  "ripple_address": [
    {
      "value": "string"
    }
  ],
  "zcash_address": [
    {
      "value": "string"
    }
  ]
}

DocumentHit

Properties

Name Type Required Restrictions Description
page Page true none none
tag [Tag] false none none
email [Email] false none none
paste [Paste] false none none
skype [Skype] false none none
telegram [Telegram] false none none
whatsapp [WhatsApp] false none none
bitcoin_address [BitcoinAddress] false none none
polkadot_address [PolkadotAddress] false none none
ethereum_address [EthereumAddress] false none none
monero_address [MoneroAddress] false none none
ripple_address [RippleAddress] false none none
zcash_address [ZcashAddress] false none none

Email

{
  "value": "string"
}

Email

Properties

Name Type Required Restrictions Description
value string true none none

Error

{
  "code": 400,
  "message": "string"
}

Error

Properties

Name Type Required Restrictions Description
code ErrorCode true none none
message string true none none

ErrorCode

400

ErrorCode

Properties

Name Type Required Restrictions Description
ErrorCode integer false none none

Enumerated Values

Property Value
ErrorCode 400
ErrorCode 401
ErrorCode 403
ErrorCode 404
ErrorCode 409
ErrorCode 422
ErrorCode 429
ErrorCode 500

EthereumAddress

{
  "value": "string"
}

EthereumAddress

Properties

Name Type Required Restrictions Description
value string true none none

HTTPValidationError

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

HTTPValidationError

Properties

Name Type Required Restrictions Description
detail [ValidationError] false none none

ImChannelHit

{
  "channelId": 0,
  "channelTitles": [
    "string"
  ],
  "detectionDate": "2019-08-24T14:15:22Z",
  "creationDate": "2019-08-24T14:15:22Z",
  "channelPhoto": [
    "string"
  ]
}

ImChannelHit

Properties

Name Type Required Restrictions Description
channelId integer true none none
channelTitles any false none none

anyOf

Name Type Required Restrictions Description
» anonymous [string] false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
detectionDate string(date-time) true none none
creationDate string(date-time) true none none
channelPhoto any false none none

anyOf

Name Type Required Restrictions Description
» anonymous [string] false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

ImFeedHit

{
  "id": "string",
  "telegram": [
    "string"
  ],
  "detectionDate": "2019-08-24T14:15:22Z",
  "url": "string",
  "path": "string",
  "network": "string"
}

ImFeedHit

Properties

Name Type Required Restrictions Description
id string true none none
telegram [string] true none none
detectionDate string(date-time) true none none
url string true none none
path string true none none
network string true none none

ImMessageHit

{
  "userId": 0,
  "username": "string",
  "channelId": 0,
  "messageId": "string",
  "message": "string",
  "channelTitle": "string",
  "languages": [
    {
      "language": "string",
      "probability": 0
    }
  ],
  "sha1sum": "string",
  "sha256sum": "string",
  "media": "string",
  "detectionDate": "2019-08-24T14:15:22Z"
}

ImMessageHit

Properties

Name Type Required Restrictions Description
userId any false none none

anyOf

Name Type Required Restrictions Description
» anonymous integer false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
username any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
channelId any false none none

anyOf

Name Type Required Restrictions Description
» anonymous integer false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
messageId string true none none
message any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
channelTitle any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
languages any false none none

anyOf

Name Type Required Restrictions Description
» anonymous [LanguagePair] false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
sha1sum any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
sha256sum any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
media any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
detectionDate string(date-time) true none none

ImProfileHit

{
  "userId": 0,
  "usernames": [
    "string"
  ],
  "firstName": [
    "string"
  ],
  "lastName": [
    "string"
  ],
  "detectionDate": "2019-08-24T14:15:22Z",
  "profilePhoto": [
    "string"
  ]
}

ImProfileHit

Properties

Name Type Required Restrictions Description
userId integer true none none
usernames any false none none

anyOf

Name Type Required Restrictions Description
» anonymous [string] false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
firstName any false none none

anyOf

Name Type Required Restrictions Description
» anonymous [string] false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
lastName any false none none

anyOf

Name Type Required Restrictions Description
» anonymous [string] false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
detectionDate string(date-time) true none none
profilePhoto any false none none

anyOf

Name Type Required Restrictions Description
» anonymous [string] false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

Language

"av"

Language

Properties

Name Type Required Restrictions Description
Language string false none Using names from ISO 639-1

Enumerated Values

Property Value
Language av
Language ss
Language ru
Language ln
Language aa
Language mn
Language ty
Language so
Language gd
Language ug
Language ps
Language ak
Language ab
Language ta
Language Mi
Language kn
Language cr
Language ng
Language ay
Language it
Language lv
Language uk
Language ms
Language lg
Language fi
Language tn
Language te
Language cv
Language ee
Language az
Language lo
Language sd
Language sc
Language th
Language ht
Language bh
Language rm
Language ba
Language vo
Language yi
Language gn
Language hr
Language bm
Language be
Language su
Language kg
Language ky
Language ne
Language is
Language hz
Language lt
Language ff
Language sw
Language gv
Language mr
Language si
Language tg
Language mh
Language an
Language nl
Language hi
Language io
Language tl
Language ja
Language km
Language el
Language mi
Language lb
Language sl
Language mt
Language ki
Language tt
Language lu
Language sv
Language pa
Language ks
Language dv
Language id
Language mg
Language or
Language kj
Language sg
Language fy
Language za
Language ar
Language af
Language kw
Language xh
Language hy
Language ml
Language st
Language eo
Language la
Language ko
Language ia
Language sq
Language ca
Language nn
Language gl
Language ku
Language ig
Language tw
Language iu
Language hu
Language yo
Language ts
Language sk
Language dz
Language cu
Language qu
Language ro
Language fj
Language ce
Language am
Language my
Language gu
Language sm
Language ch
Language ga
Language fr
Language nd
Language pi
Language vi
Language kk
Language nv
Language ik
Language ae
Language na
Language da
Language br
Language fa
Language sr
Language ka
Language en
Language ii
Language om
Language se
Language ve
Language zh
Language no
Language ie
Language rn
Language bi
Language ho
Language fo
Language sn
Language bn
Language kl
Language nb
Language oc
Language pl
Language bg
Language as
Language li
Language tr
Language zu
Language co
Language kr
Language oj
Language to
Language sa
Language he
Language wo
Language rw
Language tk
Language uz
Language os
Language bo
Language kv
Language pt
Language mk
Language jv
Language eu
Language ur
Language ti
Language bs
Language et
Language ha
Language wa
Language cy
Language cs
Language de
Language es
Language ci

LanguagePair

{
  "language": "string",
  "probability": 0
}

LanguagePair

Properties

Name Type Required Restrictions Description
language string true none none
probability number true none none

MoneroAddress

{
  "value": "string"
}

MoneroAddress

Properties

Name Type Required Restrictions Description
value string true none none

Network

"tor"

Network

Properties

Name Type Required Restrictions Description
Network string false none none

Enumerated Values

Property Value
Network tor
Network i2p
Network zeronet
Network freenet
Network paste
Network clearnet
Network graynet

Page

{
  "id": "string",
  "url": {
    "url": "string",
    "networkProtocol": "string",
    "domainName": "string",
    "port": 0,
    "path": "string",
    "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
    "network": "tor"
  },
  "foundAt": "string",
  "pageTitle": "string",
  "language": "av",
  "html": "string",
  "text": "string",
  "sha1sum": "string",
  "sha256sum": "string",
  "ssdeep": "string",
  "detectionDate": "2019-08-24T14:15:22Z",
  "chunk": false
}

Page

Properties

Name Type Required Restrictions Description
id string true none none
url URL true none none
foundAt any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
pageTitle any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
language any true none none

anyOf

Name Type Required Restrictions Description
» anonymous Language false none Using names from ISO 639-1

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
html any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
text any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
sha1sum any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
sha256sum any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
ssdeep any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
detectionDate string(date-time) false none none
chunk boolean false none none

Paste

{
  "value": "string"
}

Paste

Properties

Name Type Required Restrictions Description
value string true none none

PhoneInfo

{
  "name": "string",
  "source": "string",
  "href": "string",
  "carrier": "string"
}

PhoneInfo

Properties

Name Type Required Restrictions Description
name string true none none
source string true none none
href any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
carrier any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

PolkadotAddress

{
  "value": "string"
}

PolkadotAddress

Properties

Name Type Required Restrictions Description
value string true none none

RansomFeedHit

{
  "id": "string",
  "companyName": "string",
  "companyLink": "string",
  "url": "string",
  "ransomwareGroup": "string",
  "detectionDate": "2019-08-24T14:15:22Z",
  "text": "string",
  "country": "string"
}

RansomFeedHit

Properties

Name Type Required Restrictions Description
id string true none none
companyName any true none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
companyLink any true none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
url string true none none
ransomwareGroup string true none none
detectionDate string(date-time) true none none
text any true none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
country any true none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

RansomwareHit

{
  "page": {
    "id": "string",
    "url": {
      "url": "string",
      "networkProtocol": "string",
      "domainName": "string",
      "port": 0,
      "path": "string",
      "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
      "network": "tor"
    },
    "foundAt": "string",
    "pageTitle": "string",
    "language": "av",
    "html": "string",
    "text": "string",
    "sha1sum": "string",
    "sha256sum": "string",
    "ssdeep": "string",
    "detectionDate": "2019-08-24T14:15:22Z",
    "chunk": false
  },
  "tag": [
    {
      "namespace": "string",
      "predicate": "string",
      "value": "string"
    }
  ],
  "ransomwareGroup": "string",
  "companyName": "string",
  "companyAddress": "string",
  "companyLink": "string",
  "country": "string"
}

RansomwareHit

Properties

Name Type Required Restrictions Description
page Page true none none
tag [Tag] false none none
ransomwareGroup string true none none
companyName any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
companyAddress any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
companyLink any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
country any false none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

Result_AggStats_

{
  "total": 0,
  "hits": [
    {
      "key": "string",
      "doc_count": 0,
      "key_as_string": "string",
      "agg": {
        "buckets": [
          {
            "key": "string",
            "doc_count": 0
          }
        ]
      }
    }
  ]
}

Result[AggStats]

Properties

Name Type Required Restrictions Description
total integer false none none
hits [AggStats] false none none

Result_DocumentHit_

{
  "total": 0,
  "hits": [
    {
      "page": {
        "id": "string",
        "url": {
          "url": "string",
          "networkProtocol": "string",
          "domainName": "string",
          "port": 0,
          "path": "string",
          "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
          "network": "tor"
        },
        "foundAt": "string",
        "pageTitle": "string",
        "language": "av",
        "html": "string",
        "text": "string",
        "sha1sum": "string",
        "sha256sum": "string",
        "ssdeep": "string",
        "detectionDate": "2019-08-24T14:15:22Z",
        "chunk": false
      },
      "tag": [
        {
          "namespace": "string",
          "predicate": "string",
          "value": "string"
        }
      ],
      "email": [
        {
          "value": "string"
        }
      ],
      "paste": [
        {
          "value": "string"
        }
      ],
      "skype": [
        {
          "value": "string"
        }
      ],
      "telegram": [
        {
          "value": "string"
        }
      ],
      "whatsapp": [
        {
          "value": "string"
        }
      ],
      "bitcoin_address": [
        {
          "value": "string"
        }
      ],
      "polkadot_address": [
        {
          "value": "string"
        }
      ],
      "ethereum_address": [
        {
          "value": "string"
        }
      ],
      "monero_address": [
        {
          "value": "string"
        }
      ],
      "ripple_address": [
        {
          "value": "string"
        }
      ],
      "zcash_address": [
        {
          "value": "string"
        }
      ]
    }
  ]
}

Result[DocumentHit]

Properties

Name Type Required Restrictions Description
total integer false none none
hits [DocumentHit] false none none

Result_ImChannelHit_

{
  "total": 0,
  "hits": [
    {
      "channelId": 0,
      "channelTitles": [
        "string"
      ],
      "detectionDate": "2019-08-24T14:15:22Z",
      "creationDate": "2019-08-24T14:15:22Z",
      "channelPhoto": [
        "string"
      ]
    }
  ]
}

Result[ImChannelHit]

Properties

Name Type Required Restrictions Description
total integer false none none
hits [ImChannelHit] false none none

Result_ImFeedHit_

{
  "total": 0,
  "hits": [
    {
      "id": "string",
      "telegram": [
        "string"
      ],
      "detectionDate": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "network": "string"
    }
  ]
}

Result[ImFeedHit]

Properties

Name Type Required Restrictions Description
total integer false none none
hits [ImFeedHit] false none none

Result_ImMessageHit_

{
  "total": 0,
  "hits": [
    {
      "userId": 0,
      "username": "string",
      "channelId": 0,
      "messageId": "string",
      "message": "string",
      "channelTitle": "string",
      "languages": [
        {
          "language": "string",
          "probability": 0
        }
      ],
      "sha1sum": "string",
      "sha256sum": "string",
      "media": "string",
      "detectionDate": "2019-08-24T14:15:22Z"
    }
  ]
}

Result[ImMessageHit]

Properties

Name Type Required Restrictions Description
total integer false none none
hits [ImMessageHit] false none none

Result_ImProfileHit_

{
  "total": 0,
  "hits": [
    {
      "userId": 0,
      "usernames": [
        "string"
      ],
      "firstName": [
        "string"
      ],
      "lastName": [
        "string"
      ],
      "detectionDate": "2019-08-24T14:15:22Z",
      "profilePhoto": [
        "string"
      ]
    }
  ]
}

Result[ImProfileHit]

Properties

Name Type Required Restrictions Description
total integer false none none
hits [ImProfileHit] false none none

Result_PhoneInfo_

{
  "total": 0,
  "hits": [
    {
      "name": "string",
      "source": "string",
      "href": "string",
      "carrier": "string"
    }
  ]
}

Result[PhoneInfo]

Properties

Name Type Required Restrictions Description
total integer false none none
hits [PhoneInfo] false none none

Result_RansomFeedHit_

{
  "total": 0,
  "hits": [
    {
      "id": "string",
      "companyName": "string",
      "companyLink": "string",
      "url": "string",
      "ransomwareGroup": "string",
      "detectionDate": "2019-08-24T14:15:22Z",
      "text": "string",
      "country": "string"
    }
  ]
}

Result[RansomFeedHit]

Properties

Name Type Required Restrictions Description
total integer false none none
hits [RansomFeedHit] false none none

Result_RansomwareHit_

{
  "total": 0,
  "hits": [
    {
      "page": {
        "id": "string",
        "url": {
          "url": "string",
          "networkProtocol": "string",
          "domainName": "string",
          "port": 0,
          "path": "string",
          "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
          "network": "tor"
        },
        "foundAt": "string",
        "pageTitle": "string",
        "language": "av",
        "html": "string",
        "text": "string",
        "sha1sum": "string",
        "sha256sum": "string",
        "ssdeep": "string",
        "detectionDate": "2019-08-24T14:15:22Z",
        "chunk": false
      },
      "tag": [
        {
          "namespace": "string",
          "predicate": "string",
          "value": "string"
        }
      ],
      "ransomwareGroup": "string",
      "companyName": "string",
      "companyAddress": "string",
      "companyLink": "string",
      "country": "string"
    }
  ]
}

Result[RansomwareHit]

Properties

Name Type Required Restrictions Description
total integer false none none
hits [RansomwareHit] false none none

Result_Stat_

{
  "total": 0,
  "hits": [
    {
      "key": "string",
      "doc_count": 0
    }
  ]
}

Result[Stat]

Properties

Name Type Required Restrictions Description
total integer false none none
hits [Stat] false none none

RippleAddress

{
  "value": "string"
}

RippleAddress

Properties

Name Type Required Restrictions Description
value string true none none

Skype

{
  "value": "string"
}

Skype

Properties

Name Type Required Restrictions Description
value string true none none

Stat

{
  "key": "string",
  "doc_count": 0
}

Stat

Properties

Name Type Required Restrictions Description
key any true none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous integer false none none

continued

Name Type Required Restrictions Description
doc_count integer true none none

Tag

{
  "namespace": "string",
  "predicate": "string",
  "value": "string"
}

Tag

Properties

Name Type Required Restrictions Description
namespace string true none none
predicate string true none none
value any true none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

Telegram

{
  "value": "string"
}

Telegram

Properties

Name Type Required Restrictions Description
value string true none none

URL

{
  "url": "string",
  "networkProtocol": "string",
  "domainName": "string",
  "port": 0,
  "path": "string",
  "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
  "network": "tor"
}

URL

Properties

Name Type Required Restrictions Description
url string true none none
networkProtocol string false none none
domainName string false none none
port integer false none none
path string false none none
signature string(uuid) false none none
network Network false none none

ValidationError

{
  "loc": [
    "string"
  ],
  "msg": "string",
  "type": "string"
}

ValidationError

Properties

Name Type Required Restrictions Description
loc [anyOf] true none none

anyOf

Name Type Required Restrictions Description
» anonymous string false none none

or

Name Type Required Restrictions Description
» anonymous integer false none none

continued

Name Type Required Restrictions Description
msg string true none none
type string true none none

VysionResponse_AggStats_

{
  "data": {
    "total": 0,
    "hits": [
      {
        "key": "string",
        "doc_count": 0,
        "key_as_string": "string",
        "agg": {
          "buckets": [
            {
              "key": "string",
              "doc_count": 0
            }
          ]
        }
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

VysionResponse[AggStats]

Properties

Name Type Required Restrictions Description
data any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Result_AggStats_ false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
error any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Error false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

VysionResponse_DocumentHit_

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "email": [
          {
            "value": "string"
          }
        ],
        "paste": [
          {
            "value": "string"
          }
        ],
        "skype": [
          {
            "value": "string"
          }
        ],
        "telegram": [
          {
            "value": "string"
          }
        ],
        "whatsapp": [
          {
            "value": "string"
          }
        ],
        "bitcoin_address": [
          {
            "value": "string"
          }
        ],
        "polkadot_address": [
          {
            "value": "string"
          }
        ],
        "ethereum_address": [
          {
            "value": "string"
          }
        ],
        "monero_address": [
          {
            "value": "string"
          }
        ],
        "ripple_address": [
          {
            "value": "string"
          }
        ],
        "zcash_address": [
          {
            "value": "string"
          }
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

VysionResponse[DocumentHit]

Properties

Name Type Required Restrictions Description
data any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Result_DocumentHit_ false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
error any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Error false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

VysionResponse_ImChannelHit_

{
  "data": {
    "total": 0,
    "hits": [
      {
        "channelId": 0,
        "channelTitles": [
          "string"
        ],
        "detectionDate": "2019-08-24T14:15:22Z",
        "creationDate": "2019-08-24T14:15:22Z",
        "channelPhoto": [
          "string"
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

VysionResponse[ImChannelHit]

Properties

Name Type Required Restrictions Description
data any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Result_ImChannelHit_ false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
error any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Error false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

VysionResponse_ImFeedHit_

{
  "data": {
    "total": 0,
    "hits": [
      {
        "id": "string",
        "telegram": [
          "string"
        ],
        "detectionDate": "2019-08-24T14:15:22Z",
        "url": "string",
        "path": "string",
        "network": "string"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

VysionResponse[ImFeedHit]

Properties

Name Type Required Restrictions Description
data any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Result_ImFeedHit_ false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
error any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Error false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

VysionResponse_ImMessageHit_

{
  "data": {
    "total": 0,
    "hits": [
      {
        "userId": 0,
        "username": "string",
        "channelId": 0,
        "messageId": "string",
        "message": "string",
        "channelTitle": "string",
        "languages": [
          {
            "language": "string",
            "probability": 0
          }
        ],
        "sha1sum": "string",
        "sha256sum": "string",
        "media": "string",
        "detectionDate": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

VysionResponse[ImMessageHit]

Properties

Name Type Required Restrictions Description
data any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Result_ImMessageHit_ false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
error any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Error false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

VysionResponse_ImProfileHit_

{
  "data": {
    "total": 0,
    "hits": [
      {
        "userId": 0,
        "usernames": [
          "string"
        ],
        "firstName": [
          "string"
        ],
        "lastName": [
          "string"
        ],
        "detectionDate": "2019-08-24T14:15:22Z",
        "profilePhoto": [
          "string"
        ]
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

VysionResponse[ImProfileHit]

Properties

Name Type Required Restrictions Description
data any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Result_ImProfileHit_ false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
error any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Error false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

VysionResponse_PhoneInfo_

{
  "data": {
    "total": 0,
    "hits": [
      {
        "name": "string",
        "source": "string",
        "href": "string",
        "carrier": "string"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

VysionResponse[PhoneInfo]

Properties

Name Type Required Restrictions Description
data any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Result_PhoneInfo_ false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
error any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Error false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

VysionResponse_RansomFeedHit_

{
  "data": {
    "total": 0,
    "hits": [
      {
        "id": "string",
        "companyName": "string",
        "companyLink": "string",
        "url": "string",
        "ransomwareGroup": "string",
        "detectionDate": "2019-08-24T14:15:22Z",
        "text": "string",
        "country": "string"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

VysionResponse[RansomFeedHit]

Properties

Name Type Required Restrictions Description
data any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Result_RansomFeedHit_ false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
error any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Error false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

VysionResponse_RansomwareHit_

{
  "data": {
    "total": 0,
    "hits": [
      {
        "page": {
          "id": "string",
          "url": {
            "url": "string",
            "networkProtocol": "string",
            "domainName": "string",
            "port": 0,
            "path": "string",
            "signature": "88fef6f3-fdb6-486d-87e1-c7ae0750df94",
            "network": "tor"
          },
          "foundAt": "string",
          "pageTitle": "string",
          "language": "av",
          "html": "string",
          "text": "string",
          "sha1sum": "string",
          "sha256sum": "string",
          "ssdeep": "string",
          "detectionDate": "2019-08-24T14:15:22Z",
          "chunk": false
        },
        "tag": [
          {
            "namespace": "string",
            "predicate": "string",
            "value": "string"
          }
        ],
        "ransomwareGroup": "string",
        "companyName": "string",
        "companyAddress": "string",
        "companyLink": "string",
        "country": "string"
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

VysionResponse[RansomwareHit]

Properties

Name Type Required Restrictions Description
data any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Result_RansomwareHit_ false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
error any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Error false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

VysionResponse_Stat_

{
  "data": {
    "total": 0,
    "hits": [
      {
        "key": "string",
        "doc_count": 0
      }
    ]
  },
  "error": {
    "code": 400,
    "message": "string"
  }
}

VysionResponse[Stat]

Properties

Name Type Required Restrictions Description
data any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Result_Stat_ false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

continued

Name Type Required Restrictions Description
error any false none none

anyOf

Name Type Required Restrictions Description
» anonymous Error false none none

or

Name Type Required Restrictions Description
» anonymous null false none none

WhatsApp

{
  "value": "string"
}

WhatsApp

Properties

Name Type Required Restrictions Description
value string true none none

ZcashAddress

{
  "value": "string"
}

ZcashAddress

Properties

Name Type Required Restrictions Description
value string true none none