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.
With this library you can interact with the ANY.RUN REST API and automate your workflow quickly and efficiently.

Available features

Sandbox API

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

TI Lookup API

  • Look up URLs and file hashes
  • Get threat intelligence data
  • Check indicators of compromise
  • Search for new IOC using YARA rules

TI Feeds API

Supports the following feed formats for search:

  • MISP
  • STIX
  • Network iocs

Other features

  • Built-in objects iterator
  • Built-in exception handling
  • The same synchronous and asynchronous interface
  • Supports Python 3.9-3.13

The library public interface overview

import os

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, simplify=True)
        print(report if report else 'No threats were found during the analysis')
        
        # 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

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.3.3.tar.gz (25.4 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.3.3-py3-none-any.whl (41.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: anyrun_sdk-1.3.3.tar.gz
  • Upload date:
  • Size: 25.4 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.3.3.tar.gz
Algorithm Hash digest
SHA256 5b0fdfd5f6067fcc70c0c1825fafb812742aa7c8f9472410c8174413d075e9bc
MD5 b122935d549e4316150beba03a25a378
BLAKE2b-256 a93a6d533e9df9f6f2e46b0becd105d697f7af1ad74b041b58a374fff485bbce

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: anyrun_sdk-1.3.3-py3-none-any.whl
  • Upload date:
  • Size: 41.2 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.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7fecdeecc5a91a5b47f77741377271ca976344683ffa14d597f7c49454846827
MD5 6ab519ccd5a76f50335f0b7a7ca37df8
BLAKE2b-256 bd989dcb8575076d2eef9e205bd0e3ef4cb5b7ac03916f0e8a904777aee96f65

See more details on using hashes here.

Provenance

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