IC-Meter Public APIs version 2 (new)

API Server:

Test data used in examples

Test User:
Test Pwd:
Test QR:
Test Meter ID:
Building ID:
Unit ID:
Test token:

Retrieve API access token

Format: POST: /icm/oauth/token
Header:
Content-Type: application/x-www-form-urlencoded
Request body:
client_id=<client id>&grant_type=<grant type>&scope=<scope>&username=<username>&password=<password>
Example:
Header:
Content-Type: application/x-www-form-urlencoded
Request body:
client_id=trusted-client&grant_type=password&scope=read&username=testUsername&password=testPassword

Retrieve list of available buildings.

Format: GET: /icm/api/buildings/2.0?extended=<extended>&hide_empty=<hide_empty>&access_token=<token>
Example:
If extended is enabled all units and external meters for each building are included. Valid values are 'true' and 'false'. 'false' is the default. If hide_empty is enabled buildings with no units or external meters are omitted. Valid values are 'true' and 'false'. 'false' is the default.

Retrieve list of units for a specified building.

Format: GET: /icm/api/buildings/2.0/units/<building_id>?access_token=<token>
Example:

Indoor climate data for specified building. Input/output timezone is UTC. Includes data for all units in the building.

Format: GET: /icm/api/buildings/2.0/building/indoor/[csv/]<building_id>?start_time=<start_time>&end_time=<end_time>&resolution=<resolution>&access_token=<token>
Example:
Example CSV:
Format: GET: /icm/api/buildings/2.0/building/indoor/[csv/]<building_id>?period=<period>&resolution=<resolution>&access_token=<token>&output_format=<format>&access_token=<token>
Example:
Example CSV:
Valid periods are: '10-min', '1-hour', '24-hours', '1-week', '30-days', '1-month', '1-year' and 'lifetime'. If a long period is specified the response time will be slow.
Valid resolutions are: 'minute', 'hour' and 'day'.

Indoor climate data for specified unit. Input/output timezone is UTC.

Format: GET: /icm/api/buildings/2.0/indoor/measurements/[csv/]<unit_id>?start_time=<start_time>&end_time=<end_time>&resolution=<resolution>&access_token=<token>
Example:
Example CSV:
Format: GET: /icm/api/buildings/2.0/indoor/measurements/[csv/]<unit_id>?period=<period>&resolution=<resolution>&access_token=<token>&output_format=<format>&access_token=<token>
Example:
Example CSV:
Valid periods are: '10-min', '1-hour', '24-hours', '1-week', '30-days', '1-month', '1-year' and 'lifetime'. If a long period is specified the response time will be slow.
Valid resolutions are: 'minute', 'hour' and 'day'.

Activity index hour data for specified building. Input/output timezone is UTC. Includes data for all units in the building.

Format: GET: /icm/api/buildings/2.0/building/activityIndex/[csv/]<building_id>?start_time=<start_time>&end_time=<end_time>&access_token=<token>
Example:
Example CSV:
Format: GET: /icm/api/buildings/2.0/building/activityIndex/[csv/]<building_id>?period=<period>&access_token=<token>
Example:
Example CSV:
Valid periods are: '10-min', '1-hour', '24-hours', '1-week', '30-days', '1-month', '1-year' and 'lifetime'. If a long period is specified the response time will be slow.

Activity index hour data for specified unit. Input/output timezone is UTC.

Format: GET: /icm/api/buildings/2.0/activityIndex/[csv/]<unit_id>?start_time=<start_time>&end_time=<end_time>&access_token=<token>
Example:
Example CSV:
Format: GET: /icm/api/buildings/2.0/activityIndex/[csv/]<unit_id>?period=<period>&access_token=<token>
Example:
Example CSV:
Valid periods are: '10-min', '1-hour', '24-hours', '1-week', '30-days', '1-month', '1-year' and 'lifetime'. If a long period is specified the response time will be slow.

Outdoor climate data for specified building. Input/output timezone is UTC. Weather data will be the same for all units within the building.

Format: GET: /icm/api/buildings/2.0/building/outdoor/[csv/]<building_id>?start_time=<start_time>&end_time=<end_time>&resolution=<resolution>&access_token=<token>
Example:
Example:
Format: GET: /icm/api/buildings/2.0/building/outdoor/<building_id>?period=<period>&resolution=<resolution>&access_token=<token>&output_format=<format>&access_token=<token>
Example:
Example:
Valid periods are: '10-min', '1-hour', '24-hours', '1-week', '30-days', '1-month', '1-year' and 'lifetime'. If a long period is specified the response time will be slow.
Valid resolutions are: 'hour' and 'day'.

Outdoor climate data for specified unit. Input/output timezone is UTC.

Format: GET: /icm/api/buildings/2.0/outdoor/measurements/<unit_id>?start_time=<start_time>&end_time=<end_time>&resolution=<resolution>&access_token=<token>
Example:
Format: GET: /icm/api/buildings/2.0/outdoor/measurements/<unit_id>?period=<period>&resolution=<resolution>&access_token=<token>&output_format=<format>&access_token=<token>
Example:
Valid periods are: '10-min', '1-hour', '24-hours', '1-week', '30-days', '1-month', '1-year' and 'lifetime'. If a long period is specified the response time will be slow.
Valid resolutions are: 'hour' and 'day'.

Changelog

2018-11-20

2018-06-01

API created by boa@neogrid.dk, 2018-06-01