---
updatedAt: 2026-03-31T12:12:41.000Z
agentTools:
  projectIndex: https://api.net2grid.com/llms.txt
---

# /disaggregation/year/{year}/month/{month}

Returns the disaggregation data for the requested month.
     When there is no disaggregation available for the requested month yet (for instance on the 1st day of
     that month), an estimation based on the preceding month’s relative disaggregation distribution (if available)
     and the requested month’s actual consumption is returned.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "NET2GRID Customer Engagement API",
    "description": "This is the B2C NET2GRID API that can be used by mobile and web apps to manage the accounts and the data that are provided by the NET2GRID Meter Data Analytics Platform.",
    "version": "13.6.0"
  },
  "servers": [
    {
      "url": "http://api.net2grid.docker",
      "description": "API server"
    }
  ],
  "paths": {
    "/v2/disaggregation/year/{year}/month/{month}": {
      "get": {
        "tags": [
          "NILM - Disaggregation"
        ],
        "summary": "/disaggregation/year/{year}/month/{month}",
        "description": "Returns the disaggregation data for the requested month.\n     When there is no disaggregation available for the requested month yet (for instance on the 1st day of\n     that month), an estimation based on the preceding month’s relative disaggregation distribution (if available)\n     and the requested month’s actual consumption is returned.",
        "operationId": "v2/getMonthlyDisaggregation",
        "parameters": [
          {
            "name": "year",
            "in": "path",
            "description": "The year for which the disaggregation data are requested.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "month",
            "in": "path",
            "description": "The month for which the disaggregation data are requested.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DisaggregationResponseDTO"
                },
                "examples": {
                  "MonthlyDisaggregationResponseExample": {
                    "$ref": "#/components/examples/MonthlyDisaggregationResponseExample"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request\n     <br/>113: Gateway not found.\n     <br/>152: User does not have a valid household object.\n     <br/>153: No valid meter found for user.\n     <br/>170: No disaggregation available.\n     <br/>184: Profile is incomplete\n     <br/>185: Labelpartner not specified for household.\n     <br/>186: Cannot find a profile for this household.\n     <br/>250: Unexpected exception while retrieving tariffs information.\n     <br/>251: No cost calculation available.\n     <br/>252: Tariff agreement not found.\n     <br/>265: Unexpected exception while retrieving customer information.\n     <br/>272: Invalid meter type.\n     <br/>274: Unit conversion not applicable.\n     <br/>400: User not provisioned.\n     <br/>422: Invalid month/year provided.\n     <br/>999: Unspecified Error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "DisaggregationDataDTO": {
        "required": [
          "electricity",
          "production",
          "gas"
        ],
        "properties": {
          "electricity": {
            "$ref": "#/components/schemas/DisaggregationReportDTO"
          },
          "production": {
            "$ref": "#/components/schemas/DisaggregationProductionDTO"
          },
          "gas": {
            "$ref": "#/components/schemas/DisaggregationReportDTO"
          }
        },
        "type": "object"
      },
      "DisaggregationProductionDTO": {
        "required": [
          "total_produced",
          "produced"
        ],
        "properties": {
          "total_produced": {
            "description": "The cost of produced energy during the month for which data is requested.",
            "type": "number"
          },
          "produced": {
            "$ref": "#/components/schemas/DisaggregationReportDTO"
          }
        },
        "type": "object"
      },
      "DisaggregationReportDTO": {
        "required": [
          "Total",
          "categories"
        ],
        "properties": {
          "Total": {
            "$ref": "#/components/schemas/DisaggregationUsageDTO"
          },
          "categories": {
            "description": "Breakdown of the total monthly energy usage into disaggregation categories.",
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/DisaggregationUsageDTO"
            }
          }
        },
        "type": "object"
      },
      "DisaggregationResponseDTO": {
        "required": [
          "status",
          "data",
          "timestamp"
        ],
        "properties": {
          "status": {
            "type": "string"
          },
          "data": {
            "$ref": "#/components/schemas/DisaggregationDataDTO"
          },
          "timestamp": {
            "description": "Timestamp of response in ISO-8601 format.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "DisaggregationUsageDTO": {
        "required": [
          "usage",
          "cost"
        ],
        "properties": {
          "usage": {
            "description": "The usage in energy units.",
            "type": "number"
          },
          "cost": {
            "description": "The cost of the usage in currency units or 0 if tariffs are not set.",
            "type": "number"
          }
        },
        "type": "object"
      },
      "ErrorDTO": {
        "properties": {
          "code": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorResponseDTO": {
        "properties": {
          "status": {
            "type": "string"
          },
          "error": {
            "$ref": "#/components/schemas/ErrorDTO"
          }
        },
        "type": "object"
      }
    },
    "examples": {
      "MonthlyDisaggregationResponseExample": {
        "summary": "Get monthly disaggregation data response",
        "value": {
          "status": "ok",
          "data": {
            "electricity": {
              "Total": {
                "usage": 222.965,
                "cost": 31.22
              },
              "categories": {
                "AlwaysOn": {
                  "usage": 60.6087,
                  "cost": 8.49
                },
                "Refrigeration": {
                  "usage": 25.4779,
                  "cost": 3.57
                },
                "Other": {
                  "usage": 34.1134,
                  "cost": 4.78
                }
              }
            },
            "production": {
              "total_produced": 50.889,
              "produced": {
                "Total": {
                  "usage": 50.889,
                  "cost": 6.62
                },
                "categories": {
                  "Solar": {
                    "usage": 50.889,
                    "cost": 6.62
                  }
                }
              }
            },
            "gas": {
              "Total": {
                "usage": 29.889,
                "cost": 18.53
              },
              "categories": {
                "SpaceHeating": {
                  "usage": 0,
                  "cost": 0
                },
                "WaterHeating": {
                  "usage": 0,
                  "cost": 0
                },
                "Cooking": {
                  "usage": 0,
                  "cost": 0
                }
              }
            }
          },
          "timestamp": "2022-02-17T11:07:08+01:00"
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "bearerFormat": "JWT",
        "scheme": "bearer"
      }
    }
  },
  "tags": [
    {
      "name": "NILM - Disaggregation"
    }
  ],
  "x-explorer-enabled": false
}
```