This starter pack gives partners and independent software vendors a practical path to build on the EcoStruxure™ - Building Data Platform (BDP).
BDP is a cloud platform that stores semantically described building data from Schneider Electric and third-party systems, and exposes that data through REST, GraphQL, and streaming APIs. REST operations are under /api/, and GraphQL requests use /graphql.
- Consume data: REST · GraphQL · Azure Event Hubs (streaming)
- Provide data: Use the Data Integration Framework (DIF) over Azure IoT Hub
- Model semantics: Brick Schema (equipment, points, rooms) · REC (sites, buildings, levels) · QUDT (units)
- Authenticate: Bearer token · Event Hub connection string · IoT Hub SAS
Use this page as the home page, then use the documentation summary for the full map of guides and workflows.
- Start here: Setup Credentials
- Then understand access behavior: Access Model and Permissions
- Explore our documentation by starting with Documentation Summary
The starter pack includes runnable examples for both consumers (read data) and providers (send data). Each example is self-contained, reads credentials from environment variables when needed, and exits with a meaningful code.
For the full catalog and quick-start guidance, see Examples Overview.
Note
Time to first query: ~10 minutes, assuming you have received your welcome email.
| Scenario | Language | What it helps you validate |
|---|---|---|
| GraphQL Quickstart | Python - Node.js - .NET | Token validity and GraphQL schema visibility for your entitlements |
| Explore REST Operations | Python | OpenAPI operation discovery and client scaffolding entry points |
| REST Quickstart | Python - Node.js - .NET | First authenticated REST call and response handling |
| Event Hub Consumer | Python | Event Hub connectivity and incoming telemetry flow |
| Scenario | Language | What it helps you validate |
|---|---|---|
| Point Group Configuration | Python | Point-group commissioning file validity before upload |
| Data Integration Framework (DIF) Telemetry Ingress | Python | Protocol-conformant telemetry payload submission |
This starter pack includes utility tools to help with common tasks: reference data synchronization and interactive equipment configuration. See more details about on tools overviews.
| Tool | Language | Purpose |
|---|---|---|
| Bricks & QUDT Reference Data Sync | .NET | Download BrickSchema and QUDT ontology data locally for semantic modeling |
| Equipment Wizard TUI | .NET | Interactive terminal wizard to generate equipment and sensor configuration JSON files |
The specifications are published on Schneider Electric Exchange, which also hosts the only supported interactive explorer (the Try it button):
- REST API (v3): OpenAPI specification
- GraphQL API (v1): schema and reference
- Ingress API (v1): OpenAPI specification
Platform status: https://ecostruxurebuildingdataplatform.statuspage.io/
For permission, access, or data configuration issues: Reply to your welcome email, or contact your Schneider Electric representative. Include the environment, the consumer or data source name, the request you made and the response you got, the answer usually depends on configuration only Schneider Electric can see.
For issues with examples or documentation: Please open a GitHub issue with a clear description of the problem, including any error messages or examples of what's unclear.
See SECURITY.md for vulnerability reporting and for the credential-handling practices every example follows.
Copyright © 2026 Schneider Electric. All rights reserved.
The examples and documentation in this starter pack are released under the MIT License, so you are free to use, copy, and modify them in your own projects, including commercial ones.