---
title: "Get anonymized household data"
method: GET
path: "/api/public/anonymized-household-data"
tags: ["Public"]
---

# Get anonymized household data

`GET /api/public/anonymized-household-data`

## Request

- Base URL: `https://api.partner.cubee.cz`
- URL: `https://api.partner.cubee.cz/api/public/anonymized-household-data`
- Auth: none required

Aggregated household data for the requested time range and granularity, anonymized for
public consumption.

## Query parameters

- `from` string, date-time, required
- `to` string, date-time, required
- `granularity` string, required

## Response `200`

OK

- AnonymizedHouseholdDataResultModel
  - `from` string, date-time
  - `to` string, date-time
  - `periods` AnonymizedHouseholdDataPeriodModel[], nullable
    - `date` string, date
    - `households` AnonymizedHouseholdDataHouseholdModel[], nullable
      - `id` string, uuid
      - `district` string, nullable
      - `name` string, nullable
      - `buyAmount` number, double, nullable
      - `buyFullPrice` number, double, nullable
      - `buyPowerPrice` number, double, nullable
      - `sellAmount` number, double, nullable
      - `sellFullPrice` number, double, nullable
      - `sellPowerPrice` number, double, nullable
      - `planModes` PlanModeModel[], nullable
        - `id` string, uuid
        - `originTypeKey` string, nullable
        - `modeTypeId` string, uuid
        - `modeTypeKey` string, nullable
        - `start` string, date-time
        - `startLocal` string, date-time
        - `end` string, date-time
        - `endLocal` string, date-time
        - `targetBattery` integer, nullable
        - `createdByUserId` string, uuid, nullable
        - `partnerId` string, uuid, nullable

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `499`: Client Error
- `500`: Internal Server Error

## Changes

- **2026-11-03** `50555858fb42`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cubee/apis/partner-api/changes/api/public/anonymized-household-data/get.md)

---

[API](https://skmtc.dev/cubee/apis/partner-api.md) - [All operations](https://skmtc.dev/cubee/apis/partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cubee/apis/partner-api/revisions/50555858fb42?raw)