Sensio Air has developed the first real-time allergen tracker that can identify mold, pet dander, dust mites and pollen in the air.
The Sensio Air APIs can be integrated in client solutions to showcase live information about indoor allergens, pollution and environmental data.
This document is intended for website and mobile developers who want to use 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 and ask any questions: 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 reasonable limits.
1- Direct Sunlight and Artificial light could interfere with the reading of the sensor, the best way to place a sensor is away from light in the darkest possible place of the room, make sure there’s no overhead lighting.
2- Having more than a couple of sensors like any wifi products hampers the right operation of the devices, while they might work, the load on the router might pose issues with data transfer.
3- The wifi connectivity works from both the app and the desktop, make sure you try both before calling us.
4- Devices are to be used within the condition of use. Do not expose the devices to non standard conditions. Please do not expose to extreme conditions like heat, sunlight or humidity and do not leave outside or expose to water.
5- Please do not attempt to open the devices as this will break the calibration
6- please make sure the sticker on the top of the devices that say peel, are removed, do not touch or swipe the glass, only use canned air for clearing particles from the analysis plate.
This API provides you with information detected by the sensor at regular intervals. The factory setting is set to one reading every 20 minutes for allergens and every 4 minutes for pollutants but can be modified to suit your business needs.
Please use https://app.swaggerhub.com/apis/Sensio-Air/indoor-data/2020-01-14T103941Z for testing, have your API Key and Device Serial number at hand
You can also access the detailed number of allergens identified:
Detailed allergen levels including the allergen name under "parameter_name" and the number of particles detected under "log_value"
Method: POST
Endpoint: https://30ktbuenbj.execute-api.eu-west-1.amazonaws.com/default/Indoor_Data_Indexes
Headers:
KEY
VALUE
x-api-key
[please contact us for your unique API key]
Body:
Under the Body tab, select the button "raw" then in the code field below it, copy the following JSON:
{
"device_serial": "SERIAL_NUMBER_PROVIDED_ON_SENSIO_DEVICE"
}
and make sure to replace the placeholder string “SERIAL_NUMBER_PROVIDED_ON_SENSIO_DEVICE” by your device serial number under the format Sensio-57SJ******
{
"log_date": "2019-03-22",
"log_time": "12:17:01",
"Global Allergen Index": "5",
"Global Pollution Index": "5",
"Mold Index": "5",
"Animal Dander Index": "5",
"Dust Mite Index": "1",
"Pollen Index": "4",
"VOC Index": "1",
"CO2 Index": "5",
"Temperature": "25.6 ºC",
"Humidity": "31.2 %"
}
CODE
MESSAGE
DESCRIPTION
400
Device not available!
The serial number is incorrect
400
Device not provided!
The serial number of the device was not provided
400
Device not sending data!
The device is not sending data, please check internet connection then contact support.
403
Forbidden
The API key was not provided or was incorrect
403
Missing Authentication Token
The URL provided is not in the correct format
Method: POST
Description: This API takes multiple Serial Numbers for Sensio Devices and returns the indoor indexes for all the devices. It is used for the bulk import of indoor devices indexes to another system. Calling the bulk indoor data indexes will save time for import compared to calling Indoor Data Indexes for each device. The API is limited to 50 devices per call.
Endpoint: https://30ktbuenbj.execute-api.eu-west-1.amazonaws.com/default/bulk_indoor_data_indexes
Headers:
KEY
VALUE
x-api-key
[please contact us for your unique API key]
Body:
Under the Body tab, select the button "raw" then in the code field below it, copy the following JSON:
{
"device_serial_numbers": [
"SERIAL_NUMBER_PROVIDED_ON_SENSIO_DEVICE",
"ANOTHER_SERIAL_NUMBER_PROVIDED_ON_SENSIO_DEVICE"
]
}
and make sure to replace the placeholder string “SERIAL_NUMBER_PROVIDED_ON_SENSIO_DEVICE” by your device serial number under the format Sensio-57SJ******
[
{
"device_id": "string",
"device_serial_number": "string",
"device_name": "string",
"log_date": "string",
"log_time": "string",
"Global Allergen Index": "string",
"Global Pollution Index": "string",
"Mold Index": "string",
"Animal Dander Index": "string",
"Pollen Index": "string",
"VOC Index": "string",
"CO2 Index": "string",
"Temperature": "string",
"Humidity": "string",
"Dust Mite Index": "string"
},
{
"device_id": "string",
"device_serial_number": "string",
"device_name": "string",
"log_date": "string",
"log_time": "string",
"Global Allergen Index": "string",
"Global Pollution Index": "string",
"Mold Index": "string",
"Animal Dander Index": "string",
"Pollen Index": "string",
"VOC Index": "string",
"CO2 Index": "string",
"Temperature": "string",
"Humidity": "string",
"Dust Mite Index": "string"
}
]
CODE
MESSAGE
DESCRIPTION
400
Device not available!
The serial number is incorrect
400
Device not provided!
The serial number of the device was not provided
400
Device not sending data!
The device is not sending data, please check internet connection then contact support.
403
Forbidden
The API key was not provided or was incorrect
403
Missing Authentication Token
The URL provided is not in the correct format
Method:
POST
Headers:
KEY
x-api-key
VALUE
[please contact us for your unique API key]
Parameters:
KEY
serial_no
VALUE
please enter the serial number of your device (format Sensio-BR7LF*******)
[
{
"sensio_id": "150",
"category_name": "Allergen Count",
"category_color": null,
"parameter_name": "Alternaria Mold",
"log_value": 24,
"particle_category": "1",
"env_index": "4",
"log_unit": " particles",
"log_intensity": "Moderate"
},
{
"sensio_id": "150",
"category_name": "Allergen Count",
"category_color": null,
"parameter_name": "Cat Pet Dander",
"log_value": 9,
"particle_category": "2",
"env_index": "2",
"log_unit": " particles",
"log_intensity": "Low"
},
{
"sensio_id": "150",
"category_name": "Allergen Count",
"category_color": null,
"parameter_name": "Cladosporium Mold",
"log_value": 17,
"particle_category": "1",
"env_index": "4",
"log_unit": " particles",
"log_intensity": "Moderate"
},
{
"sensio_id": "150",
"category_name": "Allergen Count",
"category_color": null,
"parameter_name": "Dog Pet Dander",
"log_value": 19,
"particle_category": "2",
"env_index": "3",
"log_unit": " particles",
"log_intensity": "Low"
},
{
"sensio_id": "150",
"category_name": "Allergen Count",
"category_color": null,
"parameter_name": "Mugwort Pollen",
"log_value": 9,
"particle_category": "4",
"env_index": "2",
"log_unit": " particles",
"log_intensity": "Low"
},
{
"sensio_id": "150",
"category_name": "Allergen Count",
"category_color": null,
"parameter_name": "Oak Pollen",
"log_value": 6,
"particle_category": "4",
"env_index": "1",
"log_unit": " particles",
"log_intensity": "Very Low"
},
{
"sensio_id": "150",
"category_name": "Harmful Gas",
"category_color": null,
"parameter_name": "Volatile Org. Compound",
"log_value": 39,
"particle_category": null,
"env_index": "1",
"log_unit": " ppb",
"log_intensity": "Very Low"
},
{
"sensio_id": "150",
"category_name": "Harmful Gas",
"category_color": null,
"parameter_name": "Carbon Dioxide",
"log_value": 660,
"particle_category": null,
"env_index": "4",
"log_unit": " ppm",
"log_intensity": "Moderate"
},
{
"sensio_id": "150",
"category_name": "Temperature & Humidity",
"category_color": null,
"parameter_name": "Temperature",
"log_value": 30,
"particle_category": null,
"env_index": 1,
"log_unit": " ºC",
"log_intensity": "Very Low"
},
{
"sensio_id": "150",
"category_name": "Temperature & Humidity",
"category_color": null,
"parameter_name": "Humidity",
"log_value": 27,
"particle_category": null,
"env_index": 1,
"log_unit": " %",
"log_intensity": "Very Low"
},
{
"sensio_id": "150",
"category_name": "Temperature & Humidity",
"category_color": null,
"parameter_name": "Light Intensity",
"log_value": 0,
"particle_category": null,
"env_index": 1,
"log_unit": " lux",
"log_intensity": "Very Low"
}
]
Method: POST
Description: This API takes multiple Serial Numbers for Sensio Devices and returns the indoor details for all the devices. If the user needs to import the details for indoor devices for multiple devices, the user can use this API which is faster than calling the Indoor data details API for each device.The API is limited to data from 50 devices.
Endpoint: https://30ktbuenbj.execute-api.eu-west-1.amazonaws.com/default/bulk_indoor_data_details
Headers:
KEY
VALUE
x-api-key
[please contact us for your unique API key]
Body:
Under the Body tab, select the button "raw" then in the code field below it, copy the following JSON:
{
"device_serial_numbers": [
"SERIAL_NUMBER_PROVIDED_ON_SENSIO_DEVICE",
"ANOTHER_SERIAL_NUMBER_PROVIDED_ON_SENSIO_DEVICE"
]
}
and make sure to replace the placeholder string “SERIAL_NUMBER_PROVIDED_ON_SENSIO_DEVICE” by your device serial number under the format Sensio-57SJ******
[ // all devices
[ // one device allergen data
{ // allergen data
"sensio_id": "string",
"device_serial_number": "string",
"device_name": "string",
"log_date": "string",
"log_time": "string",
"category_name": "string",
"category_color": "string",
"parameter_name": "string",
"log_value": "string",
"particle_category": "string",
"env_index": "string",
"log_unit": "string",
"log_intensity": "string"
}
]
]
CODE
MESSAGE
DESCRIPTION
400
Device not available!
The serial number is incorrect
400
Device not provided!
The serial number of the device was not provided
400
Device not sending data!
The device is not sending data, please check internet connection then contact support.
403
Forbidden
The API key was not provided or was incorrect
403
Missing Authentication Token
The URL provided is not in the correct format
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 & Sensio Air Inc. All information is subject to change without prior notice.
Sensio Air has developed the first real-time allergen tracker that can identify mold, pet dander, dust mites and pollen in the air.
The Sensio Air APIs can be integrated in client solutions to showcase live information about indoor allergens, pollution and environmental data.
This document is intended for website and mobile developers who want to use 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 and ask any questions: 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 reasonable limits.
