API pública v1.0.0

Dados Abertos para integração

Consulte dados públicos do portal por uma API REST versionada, com respostas JSON ou CSV, paginação, filtros e acesso sem autenticação.

Abrir catálogo OpenAPI 3.1

Características

Somente leitura e sem chave de API
CORS liberado para integrações
Até 500 registros por página
UTF-8, JSON e exportação CSV
Versão estável no endereço /v1

GET

Licitações

Testar JSON CSV

GET /api/dados-abertos/v1/licitacoes?pagina=1&limite=20

Parâmetros de consulta

Parâmetro	Descrição	Padrão
municipioId	Identificador municipal; dispensável no domínio próprio.	domínio atual
pagina	Página a consultar, iniciando em 1.	1
limite	Itens por página, entre 1 e 500.	50
q	Busca textual em todos os campos públicos.	—
campos	Projeção: campos separados por vírgula.	todos
formato	Formato da resposta: json ou csv.	json
qualquer campo	Filtro exato, por exemplo: ano=2026 ou status=aberta.	—

JavaScript

const response = await fetch('/api/dados-abertos/v1/licitacoes?pagina=1&limite=20')
const { data, meta, links } = await response.json()
console.log(meta.total, data)

cURL

curl -H "Accept: application/json" "/api/dados-abertos/v1/licitacoes?pagina=1&limite=20"

Estrutura da resposta

data contém os registros; meta informa página, limite, total e município; links oferece URLs para navegar entre as páginas. O cabeçalho X-Total-Count também informa o total encontrado.

Datas são fornecidas preferencialmente em ISO 8601. Valores monetários são números, sem formatação. Campos sem informação podem ser omitidos. Integrações devem ignorar campos desconhecidos para permanecerem compatíveis com futuras adições.