REST API | Developers

REST API

Estimated reading time: Less than a minute

A REST API is available at http://127.0.0.1:5000 (the port can be changed thanks to --api-port) when speculos is running. The specification of the API can be found at this URL, or from the swagger.io demo website.

This API is meant to be used in test environments to automate actions on the device such as:

Usage

For instance, pressing the left button is as simple as:

curl -d '{"action":"press-and-release"}' http://127.0.0.1:5000/button/left

and taking a screenshot of the device:

curl -o screenshot.png http://127.0.0.1:5000/screenshot

Web UI

There is a web user interface running directly on http://127.0.0.1:5000, which communicates with the API:

screenshot btc nano s


Did you find this page helpful?


How would you improve this page for developers?



Debug: how to use GDB
Automation: press buttons automatically
Getting Started
Theme Features
Customization