Skip to main content

This is the official Python client library for ANY.RUN. Automate management of ANY.RUN REST endpoints

Project description

ANY.RUN logo


ANY.RUN SDK

This is the official Python client library for ANY.RUN, supporting the cybersecurity solutions like the Interactive Sandbox, TI Lookup, and TI Feeds.
With this library you can interact with the ANY.RUN REST API and automate your workflow quickly and efficiently.

Available features

  • Built-in objects iterator and exception handling
  • Synchronous and asynchronous interface
  • Python 3.9-3.13 support

Sandbox API

ANY.RUN Sandbox is an online interactive sandbox for malware analysis, a tool for detection, monitoring, and research of cyber threats in real time.

  • Submit files and URLs for analysis
  • Monitor analysis progress in real-time
  • Get detailed reports
  • Manage the tasks

TI Lookup API and YARA Search

TI Lookup is a searchable database of IOCs, IOAs, IOBs, and events for threat hunting and a service for browsing malicious files by their content. Perform deep searches, look up threats online, and enrich your security solutions.

  • Look up URLs and file hashes
  • Search for IOCs using YARA rules
  • Get threat intelligence data
  • Monitor search progress in real time
  • Get detailed analysis results

TI Feeds API

Threat Intelligence Feeds provide data on the known indicators of compromise: malicious IPs, URLs, Domains Supports the following feed formats:

  • MISP
  • TAXII STIX
  • Network IOCs

Note:

Please inline ANY.RUN API-Key and Basic authorization token using the prefix:

API-KEY format: API-KEY WmNfqnpo...2Sjon7mtvm8e 
Basic token format: Basic c2VtZW5f...GCd0RvUg==

The library public interface overview

import os
from pprint import pprint

from anyrun.connectors import SandboxConnector


def main():
    with SandboxConnector.android(api_key) as connector:
        # Initialize the url analysis
        task_id = connector.run_url_analysis('https://any.run')
        print(f'Analysis successfully initialized. Task uuid: {task_id}')
        
        # View analysis status in real time
        for status in connector.get_task_status(task_id):
            print(status)
        
        # Get report results
        report = connector.get_analysis_report(task_id)
        pprint(report)
        
        # Remove the task from history
        connector.delete_task(task_id)


if __name__ == '__main__':
    # Setup ANY.RUN api key
    api_key = os.getenv('ANY_RUN_Sandbox_API_KEY')
    main()

You can find additional usage examples here

Installation Guide

You can install the SDK using pip or any other package manager

$ pip install anyrun-sdk

Also, you can install the SDK manually using pyproject.toml

$ git clone git@github.com:anyrun/anyrun-sdk.git
$ cd anyrun-sdk
$ python -m pip install .

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Useful links

TI Lookup query Guide
ANY.RUN API documentation

Contact us

Support, sales, and trial inquiries – support@any.run
Public relations and partnerships – pr@any.run

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anyrun_sdk-1.9.8.tar.gz (31.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

anyrun_sdk-1.9.8-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

Details for the file anyrun_sdk-1.9.8.tar.gz.

File metadata

  • Download URL: anyrun_sdk-1.9.8.tar.gz
  • Upload date:
  • Size: 31.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for anyrun_sdk-1.9.8.tar.gz
Algorithm Hash digest
SHA256 89656452a36d255d2194d9466b447cd180b1f375cfaddc618a7d68ce87fbd310
MD5 e96c6a4f1de7247f71e8d16e4dc4c455
BLAKE2b-256 90e01d85851515660daf571032ed148ab9bdc7132a097eb32198eafddb605ab1

See more details on using hashes here.

Provenance

The following attestation bundles were made for anyrun_sdk-1.9.8.tar.gz:

Publisher: release-action.yml on anyrun/anyrun-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file anyrun_sdk-1.9.8-py3-none-any.whl.

File metadata

  • Download URL: anyrun_sdk-1.9.8-py3-none-any.whl
  • Upload date:
  • Size: 49.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for anyrun_sdk-1.9.8-py3-none-any.whl
Algorithm Hash digest
SHA256 5a208990cb56d39baa3c206b025e52542d043746ac348a9183120f5db1d36216
MD5 787102f9a45aad657f0489404b34d024
BLAKE2b-256 586bd234284102700f3351c9975cdc5d8d1414cf35f9adf5e9aacc6f4e49873c

See more details on using hashes here.

Provenance

The following attestation bundles were made for anyrun_sdk-1.9.8-py3-none-any.whl:

Publisher: release-action.yml on anyrun/anyrun-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page