Sensio Air has developed the first real-time airborne pathogen tracker able to identify mold, pet dander, dust mites, pollen and other particles in the air.
The Sensio Air APIs can be integrated in client solutions to showcase live information about indoor allergens, pollution and environmental data streaming from the sensors.
This document is intended for website and mobile developers who want to use the indoor air quality data provided by the Sensio Air devices.
You will need your unique token and device ID to access API responses.
Please contact our team to discuss your project and needs, learn more about pricing: air@wlab.io
Your unique API key for testing the prototype will be shared separately by email. Please do not share it with any third party and use API calls within defined limits in the agreement.
The API provides the sensor readings including allergen levels and index, pollution allergen and index along with environmental information such as temperature and humidity levels.
Environmental levels are updated every 4 minutes while allergen levels are updated every 20 minutes.
The data provided include the following:
Overview 1
Benefits 1
Data provided 1
Table of Contents 3
Getting started 4
Required software 5
Authorize your requests 5
Test the API 6
Error Messages 6
Endpoints and Methods 7
● Endpoint URL 7
● Available HTTP Methods 7
● Request header 7
○ Description 7
○ Format 7
○ Example 7
● Request Body 8
○ Description 8
○ Format 8
○ Example 8
● Response Body 9
○ Description 9
○ Format overview 9
○ Node hierarchy 10
○ Received data structures 11
■ Request node 11
■ Device node 11
■ Particle_sensor node 12
● Particle_sensor→values subnode 13
● Particle_sensor→levels subnode 14
● Particle_sensor→sizes subnode 14
■ Environment_sensor node 15
● Environment_sensor→values subnode 16
● Environment_sensor→levels subnode 16
Change Log 17
Documentation versions 17
Caution, Notice and Support 17
Caution 17
Notice 17
Support 18
Appendix 19
Sensio Air Index 19
Device and Particle Sensor versions 19
Device versions 19
Particle Sensor ML versions 20
Particle Sensor ML versions detection capabilities 20
ML003.320 detection capabilities 20
ML003.400 detection capabilities 21
The API design and documentation can be found on mlv3.sensioair.com/api and is fully compliant with Swagger (OpenAPI) standards.
Click the button labeled “Authorize” marked in the picture below:
Then fill the API key you were provided like in the picture below.Make sure the letters “Api-Key” precede the API key provided and that there’s a space in between.
Expand the bar indoor_data and click the button labeled “Try it out”.
https://mlv3.sensioair.com/api/indoor_data/
POST
The HTTP request header is used to describe the nature of the request to the server. 2 key-value pairs are expected for the request to be validated by the server: Content-Type, Authorization.The Authorization key-value pair: contains the API key provided and is used to authorize the request.The Content-Type key-value pair: should be set to “application/json” to validate the request payload of type JSON.
The format of the Authorization value is 2 alphanumeric values separated by a space character, the first should be “Api-Key” and the second corresponds to the alphanumeric API key provided by Sensio Air to the client.
The POST request requires a request body (payload) of JSON data containing the serial number(s) of the device(s) which are found on the back of the device. It also contains an attribute to define the response formatting desired.
The request body is a JSON containing the device serial numbers found on the back of the device as an Array of alphanumeric strings and a secondary attribute containing the value “json2”.
After a valid request the server should return a request body of JSON format containing the latest values recorded by both the particle sensor and the environmental sensor for each of the device(s) requested.
The response body is in JSON format as an Array of objects, each representing the data of a device. The serials provided in the request are included as a property in each object.
Each JSON object in the array follows a structure depicted in the graph below:
Detailed graphs of the particle_sensor and environment_sensor nodes are available in their appropriate sections below.
The particle sensor node data structure is shown in the graph below, and detailed in the tables following.
The particle_sensor attributes are described in detail below.[please refer to the graph R1A page 12]
This subnode contains data related to the number of allergen particles detected by the device clustered according to their size, within size brackets that are mentioned below.[ please refer to the graph R1A page12]
The environment_sensor node data structure is shown in the graph below, and detailed after.
The environment_sensor attributes are described in detail below. [ please refer to the graph R1B page15]
This subnode contains data related to the number of environmental particles detected by the device.
[ please refer to the graph R1B page15]
This subnode contains data related to the calculated environmental index (level) corresponding to each of the environmental particle types detected by the device.
[ please refer to the graph R1B page15]
The environment_sensor→levels subnode is composed of attributes based on the main types of environmental sensors, as well as a general pollution index: co2, voc, humidity, temperature, pollution
Note: the 5 values mentioned above are mentioned as [e_sensor] in the text below for reference.
Note: the pollution index corresponds to the maximum index detected between co2 and voc sensors.
[ please refer to the graph R1B page15]
By using our API you consent to the following conditions:
Storing and redistributing the API data in order to bypass our servers and minimize calls is not an acceptable practice and can lead to false data, this will be considered a breach of our T&Cs.
By using the API you accept our terms and conditions.
All products using the SENSIO AIR API will have to credit the company as below, in a clear and readable font and a hyperlink leading the below specified address.
Pollen and Pollution data by SENSIO AIR, www.sensioair.com
Health recommendation data by SENSIO AIR, www.sensioair.com
Please note that failing to respect these conditions your contract will be terminated without further notice, any remaining credits you may have will not be refunded.
Subscription automatically renews unless auto-renew is canceled at least 24-hours before the end of the current period. Account will be charged for renewal within 24-hours prior to the end of the current period, and identify the cost of the renewal. Subscriptions may be managed by the user after purchase. No cancellation of the current subscription is allowed during the active subscription period. Any unused portion of a free trial period, if offered, will be forfeited when the user purchases a subscription to that publication, where applicable.
Please note that this document is confidential and should not be distributed or disseminated without the written consent of WLAB LTD. All information is subject to change without prior notice.
For any questions and support, please contact the Sensio Air team via email: air@wlab.io
This Sensio Air Index is a range of 1 to 10 based on the negative health effects of allergens and pollutants indoors. A low Sensio Air Index corresponds to healthy air while a high Sensio Air Index can be detrimental to health.
For pollution, the proprietary index is a conservative derivative of the WHO, OSHA and EPA guidelines. For allergens, as there are no official standards, the ranges are based on our experience and existing scientific literature.
The sensor being still in the development stage, continuous improvements are made both to the hardware and particle identification algorithm.
Each machine learning version is associated with different classification types and subtypes.
Please refer to the section below for more details about the detection capabilities.
This version includes subclassification for pollen, mold and animal dander.
This version of the machine learning identification algorithm focuses on Japanese territory and commonly found pollen in Japan. This version includes subclassification for pollen only.
