Purpose of this article
Learn how to access Scaler data programmatically through the API for automated workflows and system integrations.
What the Scaler API provides
The Scaler External API allows you to integrate your own systems to automatically pull data from Scaler.
Portfolio and asset lists:
- Retrieve all portfolios associated with your account
- Retrieve all assets within a portfolio
Asset input data:
- Pull raw input data for a single asset or all assets in a portfolio
- Data returned matches the current Scaler Spreadsheet structure in JSON format
Note: The asset input data endpoint provides a snapshot of current input fields. The structure and content may change over time as the Scaler Spreadsheet evolves. This endpoint is not versioned and is intended for convenience rather than as a stable API contract.
Calculated metrics:
- Access the same calculated metrics available through the Data Export
- Retrieve processed sustainability data (energy intensities, GHG emissions, CRREM alignment, etc.)
- Available in multiple formats: compact, general, extended, and domain-specific versions
Important limitation: Calculated metrics are only available for assets with 100% data completion and no open errors or missing data warnings. Assets that don't meet these criteria will only return raw input data.
When to use the API
Use the Scaler API when you need:
- Automated data feeds to external systems
- Real-time integration with custom dashboards
- Scheduled data extraction for business intelligence tools
- Programmatic access without manual downloads
Getting started
1. Request a Bearer token
Contact your Account Operations Manager to request a Bearer token for API access.
2. Include the token in your requests
Each request requires an Authorization header with your Bearer token:
Authorization: Bearer YOUR_TOKEN_HERE
3. Review the API documentation
The Scaler External API documentation provides full endpoint details, request formats, and response schemas.
Authentication and access control
Each Bearer token is associated with a specific Scaler user account and has the same access level controls as that user. This means:
- You can only access portfolios and assets that user can access
- Permission levels match the user's role in Scaler
- Tokens maintain the same data visibility restrictions