REST API

Estimated reading time: Less than a minute

Sections in this page

• Usage
• Web UI

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:

• Taking screenshot
• Pressing buttons
• Setting or updating automation rules
• etc.

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:

---

Did you find this page helpful?

How would you improve this page for developers?

I am a developer.
Contributors will be chosen randomly to receive rewards. Check this box to send your email and participate.

Ledger collects your email address to send you rewards for your contribution to improve the Developer Portal documentation. Learn more about how we manage your data and your rights.

By providing your email address, you consent that Ledger may contact you for rewards delivery purposes. If you are part of the randomly selected contributors, we will send you an email to ask for your physical address and if necessary, ask you for additional information on the suggestion you made. Your information will only be available to Ledger and will be retained for no longer than 90 days. It may be transferred to non-European countries that ensure an adequate level of protection or under the standard contractual clauses adopted by the EU Commission.

Please note that you may withdraw your consent at any time, access your data and request their rectification or deletion. You may also request the limitation of the processing of your data. To exercise your rights or for any question on the processing of your data, please contact LEDGER’s Data Protection Officer here. If nevertheless you believe LEDGER did not adequately address your concerns and mishandled your data, you may lodge a complaint with the personal data protection authority of your country.

Debug: how to use GDB

← Previous

Automation: press buttons automatically

Next →