Skip to content

BEMServer/bemserver-api-client

Repository files navigation

BEMServer API client

Latest version

Python versions

Build status

pre-commit.ci status

Code coverage

BEMServer is a free Building Energy Management software platform.

Its purpose is to store data collected in buildings and produce useful information such as performance indicators or alerts.

This package is a client for BEMServer API, based on requests.

API client entry points

API resources API client entry point
General

/about/

-------------------------------------------------------+

/users/

-------------------------------------------------------+

/users_by_user_groups/

-------------------------------------------------------+

/user_groups/

-------------------------------------------------------+

/user_groups_by_campaigns/

-------------------------------------------------------+

/user_groups_by_campaign_scopes/

-------------------------------------------------------+

/campaigns/

-------------------------------------------------------+

/campaign_scopes/

-------------------------------------------------------+

/io/

about

-----------------------------------------------+

users

-----------------------------------------------+

user_by_user_groups

-----------------------------------------------+

user_groups

-----------------------------------------------+

user_groups_by_campaigns

-----------------------------------------------+

user_groups_by_campaign_scopes

-----------------------------------------------+

campaigns

-----------------------------------------------+

campaign_scopes

-----------------------------------------------+

io

Structural elements

/sites/

-------------------------------------------------------+

/buildings/

-------------------------------------------------------+

/storeys/

-------------------------------------------------------+

/spaces/

-------------------------------------------------------+

/zones/

-------------------------------------------------------+

/structural_element_properties/

-------------------------------------------------------+

/site_properties/

-------------------------------------------------------+

/site_property_data/

-------------------------------------------------------+

/building_properties/

-------------------------------------------------------+

/building_property_data/

-------------------------------------------------------+

/storey_properties/

-------------------------------------------------------+

/storey_property_data/

-------------------------------------------------------+

/space_properties/

-------------------------------------------------------+

/space_property_data/

-------------------------------------------------------+

/zone_properties/

-------------------------------------------------------+

/zone_property_data/

sites

-----------------------------------------------+

buildings

-----------------------------------------------+

storeys

-----------------------------------------------+

spaces

-----------------------------------------------+

zones

-----------------------------------------------+

structural_element_properties

-----------------------------------------------+

site_properties

-----------------------------------------------+

site_property_data

-----------------------------------------------+

building_properties

-----------------------------------------------+

building_property_data

-----------------------------------------------+

storey_properties

-----------------------------------------------+

storey_property_data

-----------------------------------------------+

space_properties

-----------------------------------------------+

space_property_data

-----------------------------------------------+

zone_properties

-----------------------------------------------+

zone_property_data

Timeseries

/timeseries/

-------------------------------------------------------+

/timeseries_properties/

-------------------------------------------------------+

/timeseries_property_data/

-------------------------------------------------------+

/timeseries_by_sites/

-------------------------------------------------------+

/timeseries_by_buildings/

-------------------------------------------------------+

/timeseries_by_storeys/

-------------------------------------------------------+

/timeseries_by_spaces/

-------------------------------------------------------+

/timeseries_by_zones/

-------------------------------------------------------+

/timeseries_by_events/

-------------------------------------------------------+

/weather_timeseries_by_sites/

timeseries

-----------------------------------------------+

timeseries_properties

-----------------------------------------------+

timeseries_property_data

-----------------------------------------------+

timeseries_by_sites

-----------------------------------------------+

timeseries_by_buildings

-----------------------------------------------+

timeseries_by_storeys

-----------------------------------------------+

timeseries_by_spaces

-----------------------------------------------+

timeseries_by_zones

-----------------------------------------------+

timeseries_by_events

-----------------------------------------------+

weather_ts_by_sites

Timeseries data

/timeseries_data_states/

-------------------------------------------------------+

/timeseries_data/

timeseries_datastates

-----------------------------------------------+

timeseries_data

Analysis

/analysis/

-------------------------------------------------------+

/energies/

-------------------------------------------------------+

/energy_end_uses/

-------------------------------------------------------+

/energy_consumption_timeseries_by_sites/

-------------------------------------------------------+

/energy_consumption_timeseries_by_buildings/

-------------------------------------------------------+

/energy_production_technologies/

-------------------------------------------------------+

/energy_production_timeseries_by_sites/

-------------------------------------------------------+

/energy_production_timeseries_by_buildings/

analysis

-----------------------------------------------+

energies

-----------------------------------------------+

energy_end_uses

-----------------------------------------------+

energy_cons_ts_by_sites

-----------------------------------------------+

energy_cons_ts_by_buildings

-----------------------------------------------+

energy_prod_technologies

-----------------------------------------------+

energy_prod_ts_by_sites

-----------------------------------------------+

energy_prod_ts_by_buildings

Events and notifications +

/events/

-------------------------------------------------------+

/events_by_sites/

-------------------------------------------------------+

/events_by_buildings/

-------------------------------------------------------+

/events_by_storeys/

-------------------------------------------------------+

/events_by_spaces/

-------------------------------------------------------+

/events_by_zones/

-------------------------------------------------------+

/event_categories/

-------------------------------------------------------+

/event_categories_by_users/

-------------------------------------------------------+

/notifications/

events

-----------------------------------------------+

event_by_sites

-----------------------------------------------+

event_by_buildings

-----------------------------------------------+

event_by_storeys

-----------------------------------------------+

event_by_spaces

-----------------------------------------------+

event_by_zones

-----------------------------------------------+

event_categories

-----------------------------------------------+

event_categories_by_users

-----------------------------------------------+

notifications

Services

/st_cleanups_by_campaigns/

-------------------------------------------------------+

/st_cleanups_by_timeseries/

-------------------------------------------------------+

/st_check_missings_by_campaigns/

-------------------------------------------------------+

/st_check_outliers_by_campaigns/

-------------------------------------------------------+

/st_download_weather_data_by_sites/

-------------------------------------------------------+

/st_download_weather_forecast_data_by_sites/

st_cleanup_by_campaign

-----------------------------------------------+

st_cleanup_by_timeseries

-----------------------------------------------+

st_check_missing_by_campaign

-----------------------------------------------+

st_check_outlier_by_campaign

-----------------------------------------------+

st_download_weather_by_site

-----------------------------------------------+

st_download_weather_forecast_by_site

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages