This website uses Javascript and will not work if you have it disabled or using an old version of your browser.
How to use the API

How to use the API

URLs

Every URL starts with https://bacnethelp.com/api/<version>/.

The HTTP method available is GET.

Project

/api/v1/<project-id>

A list of every devices in the project.

Example

Device

/api/v1/<project-id>/<device-id>

Information about the device (scan duration, name, objects list…)

Example

The objects list is made of integer. If you need to know what are the names of these objects, you can refer to this section.

Object type (integer value)

/api/v1/<project-id>/<device-id>/<object-type>

Information about every instance of this object type. (Object name, description, present value…)

Example

Object instance

/api/v1/<project-id>/<device-id>/<object-type>/<object-instance>

Access historical data. Returns a time series.

Example

Queries

The object instance support the following query parameters:

date-from & date-to
dates in ISO 8601 format. For example, you could specify 2012-11-03, or even 2000-11-03T07:36Z for maximum precision. If no date is provided, the returned time series is the entire object's history. Example
limit
Time series are limited to 500 data-points per queries, but you can put a lower limit if needed. If the requested time-range has more data-points than the limit, they will be distributed evenly.

Data formats

To specify a format, simply end the url with .<format-name>. We currently support the following formats:

  • .json
  • .csv
  • .html

For example, https://bacnethelp.com/api/v1/505a125e44ae42e05a750c97/1234/0/0.json will return data in the following format:

{"value":[29.552020666133956,56.46424733950354,78.33269096274833...
"time":["2012-08-12T05:29:09.718-04:00","2012-08-12T15:39:09.718-04:00"...}

If no format is provided, the API defaults to JSON.

Examples

Google Spreadsheet

You can easily import data in a Google spreadsheet document with the function importData.

As the function argument, input the API URL as a CSV format:

=Importdata("https://bacnethelp.com/api/v1/505a125e44ae42e05a750c97/1234/0/0.csv?limit=100")

/img/google-spreadsheet.png

You can then use it with the usual spreadsheet options, such as making a graph: /img/google-spreadsheet2.png

Microsoft Excel

You can import the data in excel using its web query option.

Go to data and select from web. /img/excel.png

Then input the API URL in the address bar.

/img/excel2.png (Here we used this URL.)

You will then see the html page load below the address bar. There you should check the box to select only the data-table.

Once successful, you should see the data available directly in your spreadsheet.

/img/excel3.png

You can also configure Excel to update this data regularly if required.

Objects integer value

Each BACnet object is represented by an integer value. Here is the translation table to get their names.

BACnet object numbers reference
Integer valueObject name
0Analog Input
1Analog Output
2Analog Value
3Binary Input
4Binary Output
5Binary Value
6Calendar
7Command
8Device
9Event Enrollment
10File
11Group
12Loop
13Multi State Input
14Multi State Output
15Notification Class
16Program
17Schedule
18Averaging
19Multi State Value
20Trend Log
21Life Safety Point
22Life Safety Zone
23Accumulator
24Pulse Converter
25Event Log
27Trend Log Multiple
28Load control
29Structured view
30Access door