Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

I would like to use the self-issued API key (see How to issue a self-signed API key) to search the database on the public/private instance.

Step-by-step guide

  1. Download the VxAPI wrappers here:
  2. Install Python 3.4 (or above):
  3. Take a look at the file or edit the file and specify the API key/secret and application server. Example:

    def get_config():
    return {
    'api_key': '32dourjctm0wsoc88k43g8g88',
    'api_secret': '5e8d1ef991e4acad3499db70903e9d0758f68110c8498263',
    'server': ''

  4. Print a list of available endpoints for your authorization level: python -h

  5. To track some campaigns or find samples similar to a given SHA256, use the search endpoint and utilize some of the advanced search queries. For example:

    python search similar-to:35047ad869607de0a52d54be5998f268c719bb655e168f9bff8356b1f1239c55

  6. This will yield some basic results:

  7. Using the SHA256 and environment ID, retrieve additional information (such as network traffic) from a sample using the get_summary endpoint:

    python get_summary 01837d9b63b19d04125dfcce7941f7ac0e388f67b469ba8dea9c910d5cafe363 100

  8. The most interesting search "prefix" terms can be found in the FAQ at the "Do you have some advanced search options?" section:
  9. Have fun!


Note: the restricted API keys on the public server are limited to 5 queries per minute and 200 per hour.

Content by Label
cqllabel in ("public","search","api") and type = "page" and space = "VSKB"
labelsapi public search

Page properties
Related issues