Logo NPH
Logo Github
Endpoints

GET Forecasts

Endpoint para a requisição das previsõ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

Deve ser enviado o ID de uma estação específica para retorno.

modelIdmodel

Deve ser enviado o ID de um modelo numérico específico para retorno.

paramIdparameter

Deve ser enviado o ID de um parâmetro específico para retorno.

Requisição

Para realizar a chamada, os parâmetros de filtro devem ser enviados via Query String. A autenticação é obrigatória e validada através do header apiKey. O retorno consiste em um array de objetos contendo a evolução temporal das grandezas físicas solicitadas.

import requests

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

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

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

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

Response Structure

Os dados são agrupados por estação e ordenados cronologicamente. Cada entrada possui uma marcação horária datetime para identificação individual, permitindo a reconstrução precisa da curva de previsão.

[
  {
    "id": "293885557",
    "datetime": "2025-12-12T03:00:00.000Z",
    "value": 0,
    "unit_name": "mm",
    "param_name": "Precipitação",
    "station_name": "JOSÉ MENINO",
    "latitude": "-23.965000",
    "longitude": "-46.356000",
    "model_source_name": "WRF_1KM",
    "model_owner_name": "ATMOSMARINE",
    "station_id": "61",
    "model_id": "2",
    "param_id": "2"
  },
  {
    "id": "293885558",
    "datetime": "2025-12-12T04:00:00.000Z",
    "value": 0.5,
    "unit_name": "mm",
    "model_source_name": "WRF_1KM"
    // ... a lista segue a série temporal da previsão
  }
]