Energy Solar Panels

List solar panels for a node

GET

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/nodes/{nodeId}/solar-panels

Required scope: energy:read

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

📘 Feature flag required — This endpoint is not available by default. It must be explicitly enabled for your operator account upon request. Please contact your Monta Business Partner to request access to this feature.

List solar panels for a node › path Parameters

siteId

integer · int64 · required

nodeId

integer · int64 · required

List solar panels for a node › Responses

getSolarPanels 200 response

OffsetBasedResponse_22

SolarPanel[] · required

MontaPage.Meta · required

Create a solar panel

POST

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/nodes/{nodeId}/solar-panels

Required scope: energy:write

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Create a solar panel › path Parameters

siteId

integer · int64 · required

nodeId

integer · int64 · required

Create a solar panel › Request Body

CreateSolarPanelRequest

latitude

number · double · required

longitude

number · double · required

declination

number · double · required

azimuth

number · double · required

peakProductionKw

number · double · required

externalId

string | null

Create a solar panel › Responses

createSolarPanel 201 response

SolarPanel

id

integer · int64 · required

nodeId

integer · int64 · required

externalId

string · required

latitude

number · double · required

longitude

number · double · required

declination

number · double · required

azimuth

number · double · required

peakProductionKw

number · double · required

array | null

POST/api/v1/energy/sites/{siteId}/nodes/{nodeId}/solar-panels

curl https://partner-api.monta.com/api/v1/energy/sites/:siteId/nodes/:nodeId/solar-panels \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "externalId": "externalId",
  "latitude": 0,
  "longitude": 0,
  "declination": 0,
  "azimuth": 0,
  "peakProductionKw": 0
}'

Example Request Body

{
  "externalId": "externalId",
  "latitude": 0,
  "longitude": 0,
  "declination": 0,
  "azimuth": 0,
  "peakProductionKw": 0
}

json

Example Responses

{
  "id": 0,
  "nodeId": 0,
  "externalId": "externalId",
  "latitude": 0,
  "longitude": 0,
  "declination": 0,
  "azimuth": 0,
  "peakProductionKw": 0,
  "forecast": [
    {
      "endTimestamp": "2024-08-25T15:00:00Z",
      "solarProductionW": 0
    }
  ]
}

json

application/json

Get a solar panel by ID

GET

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/nodes/{nodeId}/solar-panels/{solarPanelId}

Required scope: energy:read

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Get a solar panel by ID › path Parameters

siteId

integer · int64 · required

nodeId

integer · int64 · required

solarPanelId

integer · int64 · required

Get a solar panel by ID › Responses

getSolarPanel 200 response

SolarPanel

id

integer · int64 · required

nodeId

integer · int64 · required

externalId

string · required

latitude

number · double · required

longitude

number · double · required

declination

number · double · required

azimuth

number · double · required

peakProductionKw

number · double · required

array | null

Update a solar panel

PATCH

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/nodes/{nodeId}/solar-panels/{solarPanelId}

Required scope: energy:write

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Update a solar panel › path Parameters

siteId

integer · int64 · required

nodeId

integer · int64 · required

solarPanelId

integer · int64 · required

Update a solar panel › Request Body

UpdateSolarPanelRequest

externalId

string | null

latitude

number | null · double

longitude

number | null · double

declination

number | null · double

azimuth

number | null · double

peakProductionKw

number | null · double

Update a solar panel › Responses

updateSolarPanel 200 response

SolarPanel

id

integer · int64 · required

nodeId

integer · int64 · required

externalId

string · required

latitude

number · double · required

longitude

number · double · required

declination

number · double · required

azimuth

number · double · required

peakProductionKw

number · double · required

array | null

PATCH/api/v1/energy/sites/{siteId}/nodes/{nodeId}/solar-panels/{solarPanelId}

curl https://partner-api.monta.com/api/v1/energy/sites/:siteId/nodes/:nodeId/solar-panels/:solarPanelId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "externalId": "externalId",
  "latitude": 0,
  "longitude": 0,
  "declination": 0,
  "azimuth": 0,
  "peakProductionKw": 0
}'

Example Request Body

{
  "externalId": "externalId",
  "latitude": 0,
  "longitude": 0,
  "declination": 0,
  "azimuth": 0,
  "peakProductionKw": 0
}

json

Example Responses

{
  "id": 0,
  "nodeId": 0,
  "externalId": "externalId",
  "latitude": 0,
  "longitude": 0,
  "declination": 0,
  "azimuth": 0,
  "peakProductionKw": 0,
  "forecast": [
    {
      "endTimestamp": "2024-08-25T15:00:00Z",
      "solarProductionW": 0
    }
  ]
}

json

application/json

Delete a solar panel

DELETE

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/nodes/{nodeId}/solar-panels/{solarPanelId}

Required scope: energy:delete

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Delete a solar panel › path Parameters

siteId

integer · int64 · required

nodeId

integer · int64 · required

solarPanelId

integer · int64 · required

Delete a solar panel › Responses

deleteSolarPanel 204 response

No data returned

Get solar forecast for a panel

POST

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/nodes/{nodeId}/solar-panels/{solarPanelId}/forecast

Required scope: energy:read

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Get solar forecast for a panel › path Parameters

siteId

integer · int64 · required

nodeId

integer · int64 · required

solarPanelId

integer · int64 · required

Get solar forecast for a panel › Request Body

SolarForecastRequest

timeStart

string · date-time · required

timeEnd

string | null · date-time

Get solar forecast for a panel › Responses

getSolarForecast 200 response

SolarForecastResponse

SolarForecastItem[] · required

solarPanelId

integer | null · int64

forecastFetchedAt

string | null · date-time

Refresh solar forecast for a panel

POST

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/nodes/{nodeId}/solar-panels/{solarPanelId}/forecast/refresh

Required scope: energy:write

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Refresh solar forecast for a panel › path Parameters

siteId

integer · int64 · required

nodeId

integer · int64 · required

solarPanelId

integer · int64 · required

Refresh solar forecast for a panel › Responses

refreshSolarForecast 200 response

SolarForecastResponse

SolarForecastItem[] · required

solarPanelId

integer | null · int64

forecastFetchedAt

string | null · date-time

Energy Sites Energy Vehicles