> ## Documentation Index > Fetch the complete documentation index at: https://docs.ariscomfort.com/llms.txt > Use this file to discover all available pages before exploring further. # Get heat pump status > Returns detailed telemetry for a specific heat pump. ## OpenAPI ````yaml get /api/heatpumps/{hpId} openapi: 3.1.0 info: title: Aris API version: 1.0.0 description: > REST API for controlling Aris home comfort systems. Aris is an air-to-water heat pump system that heats, cools, and provides hot water for homes. The Aris Brain is the central controller, managing zones, fan-coil units (FCUs), heat pumps, domestic hot water (DHW), and thermal energy storage (TES). ## Base URL The Aris Brain runs on your local network. Find your Brain's address via: - mDNS: `http://aris.local` (if your network supports mDNS) - Router admin panel: Look for a device named "aris-brain" ## Authentication Most API endpoints require authentication via Bearer token. Create an API token in the Aris web UI under **Settings → API Tokens**. Include the token in the `Authorization` header: ``` Authorization: Bearer your-api-token ``` ## Real-time Updates For real-time updates, connect to the WebSocket at `ws://aris.local?token=YOUR_API_TOKEN`. The WebSocket broadcasts zone state changes, system events, and device telemetry. servers: - url: http://aris.local description: Local network (mDNS) - url: http://{brainIp} description: Local network (IP address) variables: brainIp: default: 192.168.1.100 description: Your Aris Brain's IP address security: [] tags: - name: Health description: Health check and readiness endpoints - name: System description: System-wide state and mode control - name: Zones description: Zone management, setpoints, and temperature control - name: DHW description: Domestic Hot Water tank status and history - name: TES description: Thermal Energy Storage tank status - name: HCU description: Hydronic Control Unit status - name: Heat Pumps description: Heat pump telemetry and diagnostics - name: FCUs description: Fan Coil Unit telemetry and status - name: Weather description: Weather data and forecasts - name: Events description: System event log and audit trail - name: Metrics description: VictoriaMetrics time-series data proxy - name: Prometheus description: Prometheus-compatible API for Grafana - name: Tokens description: API token management - name: Config description: System configuration (read-only) - name: Firmware description: FCU firmware OTA updates paths: /api/heatpumps/{hpId}: get: tags: - Heat Pumps summary: Get heat pump status description: Returns detailed telemetry for a specific heat pump. operationId: getHeatPump parameters: - name: hpId in: path required: true schema: type: string example: hp_outdoor_1 responses: '200': description: Heat pump status content: application/json: schema: $ref: '#/components/schemas/HeatPump' '401': $ref: '#/components/responses/Unauthorized' '404': description: Heat pump not found content: application/json: schema: $ref: '#/components/schemas/Error' security: - bearerAuth: [] components: schemas: HeatPump: type: object description: > The Heat Pump represents the physical outdoor machinery and its internal electronics. It is a child of an HCU and provides deep diagnostic data required by technicians. This device has no direct control points exposed to the system; it is controlled exclusively by the logic within the HCU. properties: hpId: type: string description: Unique identifier for the heat pump example: hp_outdoor_1 parentHcuId: type: string description: ID of the HCU that manages this heat pump example: hcu_main compressorSpeedPercent: type: integer minimum: 0 maximum: 100 description: Current inverter compressor speed (0-100%) example: 65 compressorHz: type: number description: > Inverter frequency in Hz (typically 30-120 Hz). Precise diagnostic data for performance analysis. May not be present on all systems. example: 78 fanRpm: type: integer description: Outdoor fan speed in RPM. May not be present on all systems. example: 850 defrostActive: type: boolean description: True during defrost cycle. Supply temp may dip during defrost. example: false highPressureBar: type: number description: > Refrigerant high-side pressure. For diagnosing blockages or overcharge. Diagnostic field - may not be present on all systems. example: 28.5 lowPressureBar: type: number description: > Refrigerant low-side pressure. For diagnosing leaks or expansion valve faults. Diagnostic field - may not be present on all systems. example: 8.2 compressorDischargeTempC: type: number description: > Temperature of refrigerant leaving compressor. High values indicate stress or low charge. Diagnostic field - may not be present on all systems. example: 85 compressorSuctionTempC: type: number description: | Temperature of refrigerant entering compressor. Diagnostic field - may not be present on all systems. example: 12 thermalPowerKw: type: number description: Real-time thermal power output. May not be present on all systems. example: 12.5 electricalPowerKw: type: number description: >- Real-time electrical power consumption. May not be present on all systems. example: 3.2 copInstant: type: number description: | Heat pump efficiency (COP). Only present when compressor is running. Omitted when idle or defrosting. example: 3.9 acVoltageV: type: number description: | Input voltage from grid. For detecting brownouts or dirty power. Diagnostic field - may not be present on all systems. example: 230 acCurrentA: type: number description: >- Input amperage draw. Diagnostic field - may not be present on all systems. example: 12.5 firmwareVersion: type: string description: Manufacturer firmware version. May not be present on all systems. example: v2.4.1 activeFaults: type: array description: List of active fault codes (see Fault Codes reference) items: type: string example: [] Error: type: object properties: error: type: string description: Error type message: type: string description: Human-readable error message hint: type: string description: Suggestion for resolving the error responses: Unauthorized: description: Missing or invalid authentication content: application/json: schema: type: object properties: error: type: string example: Unauthorized message: type: string example: Valid authentication required securitySchemes: bearerAuth: type: http scheme: bearer description: Session token or API token ````