Pupil Labs Real-Time Python API Client

pupil_labs.realtime_api is a Python module that wraps around the Pupil Labs Real-Time Network API while offering some convenience functions sucha as gaze ↔ frame matching, and exposing easy-to-use functions and classes to get started without having to know much about advanced programming or network communication!

Installation

pip install pupil-labs-realtime-api
# pip install -e git+https://github.com/pupil-labs/pl-realtime-api.git # from source

If you want to run the examples, you can install the package with the examples extra dependencies:

pip install "pupil-labs-realtime-api[examples]"
# uv pip install pupil-labs-realtime-api --group examples # using uv

Important

This package is only available for Pupil Invisible and Neon, Pupil Core uses a different API. If you’re working with Pupil Core, please refer to the Pupil Core Network API if you need streaming capabilities.

📚 Check out the documentation here