Welcome to the Python API Guide for Hiero. This guide aims to familiarise you with the Python API in Hiero.

It’s important to note that if you copy and paste example scripts from this guide into the Script Editor, line indentations may not be preserved. If this is the case, correct the indentations manually.


The Python API consists of two modules:

The core module has methods for querying and manipulating data loaded into Hiero. The ui module is for manipulating Hiero’s user interface. The following pages describe how to use both.

For the API reference, see the links above. To get started with the API, see the Getting Started with hiero.core page.


Examples of using Hiero’s Python ship inside Hiero’s install directory and can also be found here here.