This guide provides an overview of the Measurabl API, how to get started, and key information you need to successfully integrate with our platform.
What is the Measurabl API?
The Measurabl API allows customers and partners to programmatically interact with the Measurabl platform. This enables you to:
-
- Retrieve data from your Measurabl account (buildings, meters, readings, etc.)
-
- Create and update data in your Measurabl account
-
- Automate workflows between Measurabl and other systems
-
- Build custom integrations that extend Measurabl’s functionality
Who Can Use the Measurabl API?
The Measurabl API is now available to all Measurabl customers. Access is managed as follows:
-
- All Measurabl customers can request API access for their account
-
- Partners and vendors can access the API when authorized by a Measurabl customer
-
- Consultants and developers can integrate with the API on behalf of a customer
The customer always maintains control over who can access their data. Customers must explicitly authorize any third-party access to their Measurabl data through the API.
Getting Started in 5 Steps
1. Request API Access
Contact your Measurabl representative to request API access for your account. We’ll create API credentials (key and secret) for your organization.
2. Review the Documentation
Familiarize yourself with:
Measurabl API Documentation – Technical reference
3. Authenticate
All API requests require authentication. You’ll use your API key and secret to get an authentication token that’s valid for 24 hours.
POST /api/v0/auth/login
{
"email": "your-api-key",
"password": "your-api-secret"
}
4. Make Your First Request
Start by retrieving your portfolios:
GET /core/v0/portfolios
5. Build Your Integration
Based on your use case, start building your integration:
-
- For data extraction: Use GET endpoints to retrieve information
-
- For data creation: Use POST endpoints to create new records
-
- For data updates: Use PATCH endpoints to modify existing records
Common Use Cases
Retrieving Building Data
Regularly pull building information for your internal systems:
GET /core/v0/portfolios/{portfolio_id}/buildings
Adding Meter Readings
Automatically upload utility data from third-party sources:
POST /core/v0/portfolios/{portfolio_id}/buildings/{building_id}/meters/{meter_id}/readings
Creating New Buildings
Add new properties to your Measurabl portfolio:
POST /core/v0/portfolios/{portfolio_id}/buildings
Technical Details
API Design
-
- RESTful web service following the JSON:API specification
-
- HTTPS endpoints for secure communication
-
- JSON formatted request and response bodies
Rate Limits
The Measurabl API implements rate limiting to ensure system stability:
| Request Type | Requests Allowed | Timeframe |
| GET requests | 1000 | 5 minutes |
| Standard POST/PATCH/DELETE | 100 | 5 minutes |
| High-frequency endpoints* | 500 | 5 minutes |
| Authentication | 25 | 5 minutes |
*High-frequency endpoints include meter readings and waste meter readings
Filtering Data
The API supports RSQL for filtering data:
GET /core/v0/portfolios/{portfolio_id}/buildings?filter=size=gt=10000;city==Chicago
Need Help?
For assistance with the Measurabl API:
- Review our support center
- Contact your Measurabl representative
- Email support@measurabl.com