Endpoints

GET Measurements

Endpoint para a requisição das medições de estações específicas disponíveis na base de dados.

Parâmetros

startDateyyyy-mm-dd

Especifique a data de início da série temporal.

endDateyyyy-mm-dd

Especifique a data final da série temporal.

stationIdstation || [station_1, station2, ...]

Deve ser enviado o ID de uma estação específica ou uma lista de IDs das estações para retorno.

Requisição

Aqui é realizado o pedido de dados sobre as medições das estações no nosso banco de dados. Sua apiKey deve ser informada como header. Em seguida, você receberá os dados do período citado para as estações solicitadas.

import requests

url = "https://nph.unisanta.br/ssbs/api/measurements"

params = {
    "startDate": "2026-01-01",
    "endDate": "2026-01-07",
    "stationId": "411"
}
headers = { "apiKey": "SUA_API_KEY_AQUI" }

response = requests.get(url, params=params, headers=headers)

if response.status_code == 200:
    print(response.json())

Response Structure

O retorno é separado por estação, cada uma das medições possui a marcação horária para identificação individual.

[
  {
    "station_id": "411",
    "station_name": "Palmas",
    "station_type": "Meteorologia",
    "status": "ativa",
    "classification": "bruto",
    "datetime": "2025-10-20 00:00:00",
    "primary_value": null,   // Usado para medições únicas (ex: Marégrafo)
    "secondary_value": null, // Usado para medições duplas (ex: Nível/Vazão)
    "extra_values": {
      "vento_dir": 99.78,
      "visibilidade_m": 2000,
      "temperatura_max_C": 48.17,
      "vento_vel_max_kts": 5.61,
      "precipitacao_abs_mm": 0,
      "pressao_barometrica_hpa": 1024.33
      // ... outros parâmetros meteorológicos
    }
  }
]

primary_value: Campo dedicado a estações que operam com um parâmetro principal único. É o local padrão para encontrar o nível do mar em marégrafos ou o acumulado de precipitação em pluviômetros.

secondary_value: Reservado para variáveis secundárias ou dados complementares derivados da medição principal. Um exemplo prático ocorre em estações fluviométricas, onde o nível do rio é reportado no campo primário, enquanto a vazão calculada é registrada neste campo secundário.

extra_values: Objeto dinâmico e polimórfico projetado para sensores multivariáveis. Este campo agrupa múltiplos parâmetros simultâneos, sendo essencial para a leitura de dados de estações meteorológicas completas ou perfiladores de corrente (ADCPs).