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.5-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 TAXII STIX feed format.

Note:

You can access ANY.RUN services using an API key without a prefix. Legacy access methods are supported for backward compatibility but will be removed in future releases.

API key format: WmNfqnpo...2Sjon7mtvm8e 

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 analysis verdict
        verdict = connector.get_analysis_verdict(task_id)
        print(verdict)
            
        # 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.12.11.tar.gz (30.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.12.11-py3-none-any.whl (46.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for anyrun_sdk-1.12.11.tar.gz
Algorithm Hash digest
SHA256 4f02f8bbfa8ca7fe63aaac1b2a65a811e577aa0711460ae162ab00971b923e53
MD5 c68a0a906e6b1c129177a7672c1f890d
BLAKE2b-256 620b987d6067caf0d132db910cf5af8784e814eed20f371f3790f13012c56d1f

See more details on using hashes here.

Provenance

The following attestation bundles were made for anyrun_sdk-1.12.11.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.12.11-py3-none-any.whl.

File metadata

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

File hashes

Hashes for anyrun_sdk-1.12.11-py3-none-any.whl
Algorithm Hash digest
SHA256 9a84dd189b8e0b36c8ae90ef8292b1f685a434acff30c757d6709e18047eaf72
MD5 f6d98d52006b052610e25778e340ebfb
BLAKE2b-256 44c25ac75d518c891d7ad59f825521cca247d73b50755be85f53a24568db511b

See more details on using hashes here.

Provenance

The following attestation bundles were made for anyrun_sdk-1.12.11-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