Smart Biogas API documentation

Introduction

Welcome to the Smart Biogas REST API documentation!

Begin

API tokens are distributed to all users. Log in to Smart Biogas and go to the 'Settings' section of the platform which can be accessed in the secondary drop down menu next to the profile icon. Here you will be able to generate an API key that is unique to your user. You will need to submit this key in an authorization header along with every request you make. If you do not see your API key, get in touch with a member of staff at support@smartbiogas.io

Documentation

Documentation is maintained in Swagger in an open API spec here: https://api.smartbiogas.io/open-api

This can also be downloaded in json format here: https://api.smartbiogas.io/open-api.json

At the moment, there is only 1 API to receive raw data from a smart meter. There will be more to follow.

Outputs

Parameter	Type	Description
timestamp	string	ISO format (date, datetime and timezone)
staticpressurePa	number	The static pressure in pascals.
flowLph	number	The flow of gas in litres per hour.
volumeL	number	Gas volume passed through the meter in litres. This is an ever increasing counter. This is a calculated field and not necessarily the same number reported by the meter as it accounts for device resets.
batteryV	number	Battery voltage in volts.
batteryA	number	Battery charging current in amps.
solarV	number	The voltage of the solar input in volts.
tempInternalDegC	number	The temperature measured by the CPU in degrees celsius.
tempExternalDegC	number	If an NTC thermistor is attached to the RJ45 port, a temperature is shown in degrees celsius, else NULL
rssiDb	number	Signal strength in dB. The scale is from 0 to -120. The closer to 0, the stronger the signal.