Skip to main content

​
Get Heat Pump Information

In this final step, we will read data from the heat pump we just connected.

​
Get Heat Pump Data

Make a GET request to retrieve heat pump information for a specific user: 
curl -X GET \
  'https://app.podero.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {auth_token}'

​
Response

You should receive data similar to this: 
[
  {
    "id": "8c6efd5a-36d2-4c3d-83a8-b7c9f39242cd",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T14:25:00Z",
    "owner": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "[email protected]"
    },
    "building": "94964bf8-4ec9-4f3f-b10e-0fe21980279e",
    "is_authenticated": true,
    "is_smart_optimization_active": true,
    "device_model": {
      "manufacturer": "Nibe",
      "model": "S-Series",
      "device_type": {
        "short_name": "hp_atw",
        "long_name": "Heat Pump (Air-to-Water)"
      },
      "year": null
    },
    "operational_mode": "heating",
    "current_power_consumption_w": 2500,
    "indoor_actual_temperature": 21.5,
    "outdoor_temperature": 5.3,
    "consumption_last_day_kwh": 45.3,
    "consumption_last_week_kwh": 287.6,
    "consumption_last_month_kwh": 1204.8,
    "authorization_url": null
  }
]

​
Key Response Fields

​
id
string (UUID)
Unique identifier for the heat pump device.
​
is_authenticated
boolean
Whether the device is successfully connected to the manufacturer’s API.
​
is_smart_optimization_active
boolean
Whether Podero’s optimization algorithm is actively controlling this device.
​
device_model
object
Information about the device manufacturer, model, and type.
​
current_power_consumption_w
number
Current power consumption in watts.
​
indoor_actual_temperature
number
Current indoor temperature in degrees Celsius.
​
consumption_last_day_kwh
number
Total energy consumption in the last 24 hours (kWh).

​
Congratulations! 🎉

You have now successfully:
  • ✅ Registered an OAuth2 application
  • ✅ Generated an access token
  • ✅ Created your first user
  • ✅ Updated user information
  • ✅ Connected a heat pump device
  • ✅ Retrieved device data via the API

​
What’s Next?

You can now:
  • Fetch user, building, and device data with GET methods
  • Create more resources using POST methods
  • Update existing resources using PUT methods
  • Delete resources using DELETE methods

User Journeys

Explore common workflows and use cases

API Reference

Complete parameter documentation

Authentication Guide

Deep dive into OAuth2 authentication

Low-Level API Docs

Interactive API documentation

​
Need Help?

For detailed API documentation, visit: https://app.podero.com/api/partners/v2.0/docs
For questions or support, contact your account manager or email [email protected]