API de consulta SIMQUA (1.0.0)

Download OpenAPI specification:

Introdução

A API de consulta do SIMQUA permitir que os usuários realizem consultas aos Dados Históricos e Situação Atual das estações. Através de endpoints específicos, os dados podem ser obtidos no formato JSON e um código HTTP indicando o sucesso ou falha da operação.

api-consulta

api_consulta_estacao_retrieve

Retorna detalhes da estação selecionada

Authorizations:

None

path Parameters

id

required

integer

ID da estação

Responses

Response samples

200

Content type

application/json

{"id": 6,
"nome": "EF06 - Piracicaba",
"entidade_responsavel": "Companhia Ambiental do Estado de São Paulo",
"entidade_operadora": "Companhia Ambiental do Estado de São Paulo - CETESB",
"status_operacional": "Ativa",
"inicio_operacao": "2000-02-24",
"fim_operacao": "",
"dados_consistidos_ate": "Dados não consistidos",
"latitude": -22.700277777777778,
"longitude": -47.711666666666666,
"classe_corpo_dagua": 2,
"corpo_dagua": "Rio Piracicaba",
"ponto_de_amostragem": "",
"ughri": 5,
"logradouro": "Estrada dos Marins",
"numero": "S/N",
"complemento": "Sítio do Bonato",
"bairro": "Pau Dalhinho",
"municipio": "Piracicaba",
"cep": "13400-000",
"area_de_drenagem": 10768.4,
"altitude": 461,
"profundidade_de_medicao": 0.5,
"importancia_ambiental": "Estação localizada a jusante da Cidade de Piracicaba.",
"bacia_hidrografica": "Piracicaba",
"caracterizacao_hidrica": "",
"parametros_disponiveis": [{"id": 29,
"nome": "Clorofila",
"unidade": "µg/L"
},
{"id": 30,
"nome": "Condutividade elétrica",
"unidade": "µS/cm"
},
{"id": 31,
"nome": "Ficocianina",
"unidade": "µg/L"
},
{"id": 32,
"nome": "Nível",
"unidade": "m"
},
{"id": 33,
"nome": "Oxigênio dissolvido",
"unidade": "mg/L"
},
{"id": 34,
"nome": "pH",
"unidade": ""
},
{"id": 35,
"nome": "Temperatura",
"unidade": "°C"
},
{"id": 36,
"nome": "Turbidez",
"unidade": "NTU"
},
{"id": 163,
"nome": "Vazão",
"unidade": "m³/s"
}
],
"agregacoes_disponiveis": ["todos",
"hora",
"mes",
"ano"
],
"classificacoes_disponiveis": ["validos"
]
}

api_consulta_estacao_dados_retrieve

Retorna os dados da estação especificada em diversas agregações

Authorizations:

None

path Parameters

id required	integer ID da estação
tipo required	string Tipo de agregação usado no retorno. Valores possíveis: `"minuto"`, `"hora"`, `"dia"`, `"mes"`, `"ano"`

query Parameters

fim required	string Examples: fim=2026-02-01T17:20:00 - 1 de fevereiro de 2026 às 17:20 A data e hora de término em formato `aaaa-mm-ddTHH:MM:00` em GMT-3"
hora	integer Examples: hora=14 - Médias para 14:00 Em caso de médias horárias, qual horário deve ser retornado. Se não especificado, retorna todos os horários.
inicio required	string Examples: inicio=2026-02-01T15:20:00 - 1 de fevereiro de 2026 às 15:20 A data e hora de início em formato `aaaa-mm-ddTHH:MM:00` em GMT-3"
parametros	Array of integers Os IDs dos parâmetros a serem retornados. Se não especificado, retorna todos os parâmetros disponíveis. Exemplo: [4,5]

Responses

Response samples

200

Content type

application/json

{"id": 6,
"nome": "EF06 - Piracicaba",
"dados_consistidos_ate": "Dados não consistidos",
"dados": "[{\"turbidez\":15.27,\"temperatura\":null,\"data_hora\":\"2024-07-04T00:00:00\"},{\"turbidez\":15.5,\"temperatura\":null,\"data_hora\":\"2024-07-04T01:00:00\"},{\"turbidez\":15.9,\"temperatura\":null,\"data_hora\":\"2024-07-04T02:00:00\"},{\"turbidez\":16.44,\"temperatura\":null,\"data_hora\":\"2024-07-04T03:00:00\"}]"
}

api_consulta_estacao_list_list

Retorna a lista de estações autorizadas para o usuário

Authorizations:

None

Responses

Response samples

200

Content type

application/json

Example

Usuário tem permissões a estações

[[{"id": 1,
"nome": "EF01 - Mogi das Cruzes",
"entidade_responsavel": "Companhia Ambiental do Estado de São Paulo - CETESB",
"entidade_operadora": "Companhia Ambiental do Estado de São Paulo - CETESB",
"status_operacional": "Ativa"
},
{"id": 6,
"nome": "EF06 - Piracicaba",
"entidade_responsavel": "Companhia Ambiental do Estado de São Paulo - CETESB",
"entidade_operadora": "Companhia Ambiental do Estado de São Paulo - CETESB",
"status_operacional": "Ativa"
}
]
]

api_consulta_situacao_atual_retrieve

Retorna a situação atual da estação selecionada

Authorizations:

None

path Parameters

id

required

integer

ID da estação

Responses

Response samples

200

Content type

application/json

{"id": 6,
"nome": "EF06 - Piracicaba",
"entidade_responsavel": "Companhia Ambiental do Estado de São Paulo",
"entidade_operadora": "Companhia Ambiental do Estado de São Paulo - CETESB",
"status_operacional": "Ativa",
"municipio": "Piracicaba",
"corpo_dagua": "Rio Piracicaba",
"status_ambiental": "atende à legislação",
"ultima_atualizacao": "2024-07-05T12:05:00",
"dados_consistidos_ate": "Dados não consistidos"
}