The API is used to retrieve data from MyCirrus cloud and to receive live data and status updates.
The API supports all Quantum noise monitors and environmental sensors accessible through the Quantum platform.
The API is available to all MyCirrus users with an active subscription. Features differ depending on instrument capabilities and subscription level.
The best way to get started is by following our Quickstart guide. This guide will help you set up your environment and make your first request in minutes.
Check out the other Guides for more information on using the APIs and various related topics.
The main part of the API uses the REST protocol and provides most of the functionality including retrieving data.
The second part uses WebSockets to provide live data and instant updates of status changes.
Instrument info, Data and Webhooks
Using this part of the API you can retrieve information about your instruments, change some settings and perform various actions.
You can also retrieve data from your instruments and set up webhooks to receive notifications when new data is available.
Live data and status
Using this part of the API you can receive live data and status updates from your instruments.
You can also perform some actions on your instruments and receive notifications when the action is completed.
These examples demonstrate how to connect to the API, authenticate using an API key, and perform basic operations such as retrieving instrument information and measurement data.
Basic Node.js client
Simple client application that uses Node.js to access the main API (REST)
Live Node.js client
Simple client application that uses Node.js to access the live API (WebSocket)
Basic C# client
Simple client application that uses C# to access the main API (REST)
Live C# client
Simple client application that uses C# to access the live API (WebSocket)