Como Usar

Medições

O módulo de medições trabalha com informações oficiais que são verificadas e tratadas pela equipe do NPH.

Parâmetros

stationsList[str | int] | str | int

Deve ser enviada uma estação ou uma lista de estações.

start_datestr | date

Data de início para a consulta dos dados.

end_datestr | date

Data final para a consulta dos dados.

return_valueint

Define a variável de retorno (0 = primary_value, 1 = secondary_value, 3 = extra_values).

time_offsettimedelta

Ajuste de fuso horário a ser aplicado nas datas.

Função Principal

df_measurements = client.get_measurements(stations, start_date, end_date, return_value)

Faz uma chamada na api com suas credenciais já definidas. Retorna os valores das estações encontradas em formato de DataFrame combinado, cada estação sendo uma coluna com datetime index.

Exemplo de implementação

Primeiro, realize os imports e a autenticação do cliente:

# Importe a biblioteca e configure seu cliente
import NPHClient
from datetime import timedelta

apiKey = 'API_KEY'
client = NPHClient(apiKey)

Em seguida, configure os filtros e execute a requisição:

# Defina os parâmetros e realize a chamada
start_date = '2025-12-12'
end_date = '2025-12-13'
stations = [351]

df = client.get_measurements(
  stations=stations, 
  start_date=start_date, 
  end_date=end_date, 
  return_value=0
)

Por fim, será recebido como retorno um DataFrame com as informações das estações de acordo com a requisição e filtragem.

station_name        Palmas
datetime                  
2025-12-12 00:00:00    1.32
2025-12-12 00:10:00    1.35
2025-12-12 00:20:00    1.26
2025-12-12 00:38:00    1.28
2025-12-12 00:48:00    1.30
...                     ...
2025-12-12 23:10:00    1.13
2025-12-12 23:20:00    1.18
2025-12-12 23:32:00    1.16
2025-12-12 23:42:00    1.17
2025-12-12 23:52:00    1.15