Skip to main content

Onboard API SDK

Project description

Onboard Portal Python SDK

PyPI PyPI - Python Version PyPI - Status PyPI - License

This package provides Python bindings to Onboard Data's building data API. For more details, you can navigate to the API & Docs Page to read the Getting Started Documentation section in the portal. You'll have access to this page once you've signed up for our sandbox or you've been given access to your organization's account.

API Access

You'll need an API key or existing account in order to use this client. If you don't have one and would like to start prototyping against an example building please request a key here.

Once you have a key, data access is explicitly granted by attaching one or more 'scopes' to the key. Our endpoints are grouped by scope on the swagger documentation viewer.

Client usage example

First, you'll need to install the client (requires Python >= 3.7)

$ pip install onboard.client

Now you can use the client to fetch timeseries data for sensors by building or based on type. This example requires an API key with the scopes general and buildings:read.

from onboard.client import OnboardClient
client = OnboardClient(api_key='ob-p-your-key-here')

client.whoami()  # verify access & connectivity

client.get_all_point_types()  # retrieve available types of sensors

# retrieve the past 6 hours of data for sensors measuring CO2 ppm
from datetime import datetime, timezone, timedelta
from onboard.client.models import PointSelector, TimeseriesQuery, PointData
from typing import List

query = PointSelector()
query.point_types = ['Zone Carbon Dioxide']
query.buildings = ['Office Building']  # one of the example buildings available in the sandbox
selection = client.select_points(query)
end = datetime.utcnow().replace(tzinfo=timezone.utc)
start = end - timedelta(hours=6)

timeseries_query = TimeseriesQuery(point_ids=selection['points'], start=start, end=end)  # Or `TimeseriesQuery(selector=query, ...)`

sensor_metadata = client.get_points_by_ids(selection['points'])
sensor_data: List[PointData] = list(client.stream_point_timeseries(timeseries_query))

Staging client usage

We provide an additional client object for users who wish to modify their building equipment and points in the "staging area" before those metadata are promoted to the primary tables. API keys used with the staging client require the staging scope, and your account must be authorized to perform READ and UPDATE operations on the building itself.

The staging area provides a scratchpad interface, where arbitrary additional columns can be added to points or equipment by using the prefix p. or e.. Any un-prefixed, user-added columns will be attached to points. Each update dictionary can modify a point, equipment or both at the same time (which implicitly reparents the point to the equipment). Each update should p.topic and/or e.equip_id to identify to the system where to apply the write. If a topic and equip_id are provided together in the same object then the system will associate that point with that equipment.

Updates use PATCH semantics, so only provided fields will be written to. Check-and-set concurrency control is available. To use it, include a .cas field with a current value to verify before processing the update. Please see the update object in the example below for more details.

from onboard.client.staging import OnboardStagingClient

staging = OnboardStagingClient(api_key='ob-p-your-key-here')

buildings = client.get_all_buildings()  # using OnboardClient from above example
all_building_details = staging.get_staging_building_details()  # a list of building-level staging information objects

building_id: int = 0  # yours here

equipment_and_points_csv = staging.get_staged_equipment_csv(building_id)  # easy to load straight into a pandas.DataFrame

# or as Python objects
equipment = staging.get_staged_equipment(building_id)
equipment_and_points = staging.get_equipment_points(building_id)

update = [
    # keys to identify the equipment and point we are modifying
    {'e.equip_id':'ahu-1', 'p.topic':'org/building/4242/my-sensor',
    # an update to a known field:
    '': 'I am renaming the name field on the point to this string'
    # an optional check-and-set guard for the name update
    '' 'this row update will fail unless the point name matches this CAS value',
    # arbitrary user-defined fields are supported, prefix them to indicate destination
    'p.your_custom_field': 'keep track of something on the point here',
    'p.custom_non-string_field': 107.5,
    'e.custom_equip_field': 'this field will get saved on the equipment, not the point'}
# concurrent write exceptions and other issues are reported here
# each update dictionary is processed separately so a given update may partially succeed
row_write_errors = staging.update_staged_equipment(building_id, update)


Copyright 2018-2021 Onboard Data Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

onboard.client-1.9.0.tar.gz (17.6 kB view hashes)

Uploaded source

Built Distribution

onboard.client-1.9.0-py3-none-any.whl (17.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page