Skip to main content

Python API

The Corellium Python API allows you to interact with your Corellium devices programmatically through HTTP requests, allowing developers to automate tasks and integrate Corellium with other services.

Access the Corellium Python API​

Customers can install the Python API through PyPI using pip install corellium-api.

Please see the Python Package Index for more details about the corellium-api package.

tip

If you see an error for externally-managed-environment, you may need to:

  1. Create a venv in your working directory using python3 -m venv my_env.
  2. Activate the venv using source my_env/bin/activate.
  3. Re-run pip install corellium-api.

Documentation​

Documentation is available on our python-api-client GitHub repository.

Authentication​

The Corellium Python API uses API keys for authentication. For more information on how to generate an API key, see the API Token article.

Example Script​

We provide a script to demonstrate how to automate tasks using the Corellium Python API. Please see the related API Example Script.