---
updatedAt: 2026-03-31T12:12:41.000Z
agentTools:
projectIndex: https://api.net2grid.com/llms.txt
---
# /solar/production/{periodType}/{year}/{monthOrWeek}
Returns the derived solar production metrics for a specific month. In the case where solar production metrics are available for only part of the specified month, the included CSD and CSR data will be calculated up to the latest day for which solar production metric data exists.
# 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/solar/production/{periodType}/{year}/{monthOrWeek}": {
"get": {
"tags": [
"NILM - Disaggregation"
],
"summary": "/solar/production/{periodType}/{year}/{monthOrWeek}",
"description": "Returns the derived solar production metrics for a specific month. In the case where solar production metrics are available for only part of the specified month, the included CSD and CSR data will be calculated up to the latest day for which solar production metric data exists.",
"operationId": "v2getSolarProductionForPeriod",
"parameters": [
{
"name": "periodType",
"in": "path",
"description": "The type of period for which we request data.",
"required": true,
"schema": {
"type": "string",
"enum": [
"weekly",
"monthly",
"yearly"
]
}
},
{
"name": "year",
"in": "path",
"description": "The year for which the solar production metrics are requested. Accepted format is YYYY (2022).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "monthOrWeek",
"in": "path",
"description": "The month or the week of the year for which the solar production metrics are requested. Accepted formats for month are numeric representations with 2 digits with leading zeros (08) or without leading zeros (8). Accepted format, in case of week, is W{numeric representation of week} (W26). In case of yearly call, this parameter is not required.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SolarProductionResponseDTO"
},
"examples": {
"GetPeriodicSolarProductionExample": {
"$ref": "#/components/examples/GetPeriodicSolarProductionExample"
}
}
}
}
},
"400": {
"description": "Invalid request
153: No valid meter found for user.
251: No available cost calculation for solar data.
274: Unit conversion not applicable. Unable to convert from Wh to kWh.
282: Solar production for this period was not found.
293: User not eligible for this action.
422: The filled in date is not correct.
999: Unspecified Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseDTO"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
}
},
"components": {
"schemas": {
"ErrorDTO": {
"properties": {
"code": {
"type": "integer"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"ErrorResponseDTO": {
"properties": {
"status": {
"type": "string"
},
"error": {
"$ref": "#/components/schemas/ErrorDTO"
}
},
"type": "object"
},
"BaseSolarProductionDataDTO": {
"properties": {
"PeakTime": {
"description": "The timestamp when the peak value of solar production was monitored for that specific day, in iso-8601 format. The current day is not included.\nFor Weekly / Monthly / Yearly level, the peak_time will contain the peak time when the highest produced power in the specified period was observed.",
"type": "string"
},
"PeakValue": {
"description": "The active power level of produced energy at the peak timestamp, in W. This value is positive, even though the actual active power in the mains time series at that time may be negative. The current day is not included.\nFor Weekly / Monthly / Yearly level, this attribute will contain the peak power level that was observed in the specified period (e.g. 4000W)",
"type": "number"
},
"EfficiencyAnnual": {
"description": "A percentage showing the annual efficiency of the solar panel for a specific day, comparing the daily solar production with the optimal yearly solar production of the solar panel.",
"type": "number"
},
"EfficiencyMonth": {
"description": "A percentage showing the monthly efficiency of the solar panel for a specific day, comparing the daily solar production with the optimal solar production of the solar panel for that specific month.",
"type": "number"
}
},
"type": "object"
},
"DailySolarProductionDataDTO": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseSolarProductionDataDTO"
},
{
"properties": {
"Delivered": {
"description": "Total energy consumed from the grid for the specified day, in kWh.\nThis field contains data up to the last day of the specified period that we have solar production metrics reported for, as of the consumer’s timezone, including that day as well.\nThe current day is not included.",
"type": "number"
},
"Received": {
"description": "Total energy returned to the grid for the specified day, in kWh.\nThis field contains data up to the last day of the specified period that we have solar production metrics reported for, as of the consumer’s timezone, including that day as well.\nThe current day is not included.",
"type": "number"
},
"DailyProduction": {
"description": "The estimated produced energy from PV panels for the day, in kWh.",
"type": "number"
},
"ProductionCost": {
"description": "Calculated cost for the specified production period",
"type": "number"
},
"OverproductionPercentage": {
"description": "The percentage of overproduction during the sunlight period of the day. It corresponds to the period from sunrise to sunset, not the whole day.\nIt describes the percentage of time within the day that the solar production is greater than the consumption. 0 means that for the entire course of the day the produced energy is self consumed.",
"type": "number"
},
"PerHour": {
"description": "Production by hour 0-23, in kWh.",
"type": "array",
"items": {
"type": "integer"
}
}
},
"type": "object"
}
]
},
"PeriodicSolarProductionDataDTO": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseSolarProductionDataDTO"
},
{
"properties": {
"Delivered": {
"description": "Total energy consumed from the grid for the specified period, in kWh.\nThis field contains data up to the last day of the specified period that we have solar production metrics reported for, as of the consumer’s timezone, including that day as well.\nThe current day is not included.",
"type": "number"
},
"Received": {
"description": "Total energy returned to the grid for the specified period, in kWh.\nThis field contains data up to the last day of the specified period that we have solar production metrics reported for, as of the consumer’s timezone, including that day as well.\nThe current day is not included.",
"type": "number"
},
"Production": {
"description": "The estimated produced energy from PV panels for the specified period, in kWh.",
"type": "number"
},
"ProductionCost": {
"description": "Calculated cost for the specified production period",
"type": "number"
},
"UsedProduction": {
"description": "Percentage of production used. The percentage of the estimated solar production that was used by the installation for self-consumption purposes. \n0 means that all produced energy was returned back to the grid, while 1 means that all produced energy was self consumed. Can be 0 or positive",
"type": "number"
}
},
"type": "object"
}
]
},
"SolarProductionResponseDTO": {
"properties": {
"status": {
"type": "string"
},
"data": {
"oneOf": [
{
"$ref": "#/components/schemas/DailySolarProductionDataDTO"
},
{
"$ref": "#/components/schemas/PeriodicSolarProductionDataDTO"
}
]
},
"timestamp": {
"description": "Timestamp of response in ISO-8601 format.",
"type": "string"
}
},
"type": "object"
}
},
"examples": {
"GetPeriodicSolarProductionExample": {
"summary": "Solar production response.",
"value": {
"status": "ok",
"data": {
"Delivered": 1940.51,
"Received": 3993.493,
"Production": 219.484,
"ProductionCost": 28.5329,
"PeakTime": "2019-09-01T16:32:10+02:00",
"PeakValue": 6003,
"UsedProduction": 0,
"EfficiencyAnnual": 0.524,
"EfficiencyMonth": 0.524
},
"timestamp": "2022-08-18T10:22:36+02:00"
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"bearerFormat": "JWT",
"scheme": "bearer"
}
}
},
"tags": [
{
"name": "NILM - Disaggregation"
}
],
"x-explorer-enabled": false
}
```