🔐 Acesso Restrito

Digite a senha para acessar a documentação

⚡ Energia Solar API

API para monitoramento de usinas fotovoltaicas Hoymiles

12
Endpoints
4
Históricos
REST
Arquitetura
JSON
Formato

📋 Listagem

GET /plants Lista todas as usinas

Retorna todas as usinas cadastradas com informações básicas de status e produção.

Exemplo de uso:
GET http://localhost:3000/plants
GET /plants/realtime Tempo real de todas as usinas

Retorna potência atual e energia do dia de todas as usinas em uma única chamada.

Exemplo de uso:
GET http://localhost:3000/plants/realtime

🔍 Detalhes da Usina

GET /plants/:id Detalhes de uma usina

Retorna informações detalhadas de uma usina específica.

Parâmetro Tipo Descrição
:id number obrigatório ID da usina
Exemplo de uso:
GET http://localhost:3000/plants/:id
GET /plants/:id/full TODOS os dados de uma usina

Retorna absolutamente todos os dados disponíveis: detalhes, localização, produção e tempo real.

Parâmetro Tipo Descrição
:id number obrigatório ID da usina
Exemplo de uso:
GET http://localhost:3000/plants/:id/full
GET /plants/:id/realtime Tempo real de uma usina

Retorna potência atual e energia do dia de uma usina específica.

Parâmetro Tipo Descrição
:id number obrigatório ID da usina
Exemplo de uso:
GET http://localhost:3000/plants/:id/realtime
GET /plants/:id/stats Estatísticas de produção

Retorna estatísticas de produção: hoje, mês, ano, total e impacto ambiental.

Parâmetro Tipo Descrição
:id number obrigatório ID da usina
Exemplo de uso:
GET http://localhost:3000/plants/:id/stats
GET /plants/:id/location Localização e endereço

Retorna coordenadas GPS, endereço completo e link do Google Maps.

Parâmetro Tipo Descrição
:id number obrigatório ID da usina
Exemplo de uso:
GET http://localhost:3000/plants/:id/location
GET /plants/:id/weather Previsão do tempo

Retorna previsão do tempo para os próximos dias na localização da usina.

Parâmetro Tipo Descrição
:id number obrigatório ID da usina
Exemplo de uso:
GET http://localhost:3000/plants/:id/weather

📊 Histórico de Produção

GET /plants/:id/history/daily Histórico diário

Retorna produção diária em kWh para um período de datas.

Parâmetro Tipo Descrição
:id number obrigatório ID da usina
start_date string opcional Data inicial (YYYY-MM-DD). Default: 1º dia do mês
end_date string opcional Data final (YYYY-MM-DD). Default: hoje
Exemplo de uso:
GET http://localhost:3000/plants/:id/history/daily?start_date=2025-12-01&end_date=2025-12-31
GET /plants/:id/history/monthly Histórico mensal

Retorna produção mensal em kWh para um ano específico.

Parâmetro Tipo Descrição
:id number obrigatório ID da usina
year string opcional Ano (YYYY). Default: ano atual
Exemplo de uso:
GET http://localhost:3000/plants/:id/history/monthly?year=2025
GET /plants/:id/history/yearly Histórico anual

Retorna produção total por ano desde o início da usina.

Parâmetro Tipo Descrição
:id number obrigatório ID da usina
Exemplo de uso:
GET http://localhost:3000/plants/:id/history/yearly
GET /plants/:id/history/hourly Potência por hora

Retorna potência gerada (W) a cada 15 minutos/hora de um dia específico.

Parâmetro Tipo Descrição
:id number obrigatório ID da usina
date string opcional Data (YYYY-MM-DD). Default: hoje
Exemplo de uso:
GET http://localhost:3000/plants/:id/history/hourly?date=2025-12-24