Python SDK for accessing data from Origin, Aurora's Market model platform.
Note
We support running the SDK in all currently supported versions of Python: 3.10 - 3.14.
Warning
Python 3.9 support is deprecated and will be removed in a future release. Please upgrade to Python 3.10 or later.
- Install the package from the git repository
# Use pip:
pip install git+https://github.com/AuroraEnergyResearch/aurora-origin-python-sdk
# Or uv:
uv add git+https://github.com/AuroraEnergyResearch/aurora-origin-python-sdk-
Add your Aurora API key to the file $home/.aurora-api-key. for example
C:\Users\Joe Bloggs\.aurora-api-keyor set as the environment variableAURORA_API_KEY. -
Import
OriginSessionand initialise.
from origin_sdk.OriginSession import OriginSession
session = OriginSession()
result = session.get_projects()
print(res[0])- See the documentation for further details on the SDK.