Dados abertos
Tudo o que o site mostra também pode ser lido por programas: uma API em JSON e feeds RSS, sem cadastro e sem chave.
Feeds RSS
Para acompanhar edições novas num leitor de notícias ou no site do próprio órgão.
GET/feed.xml
As últimas 50 edições de todos os órgãos.
GET/feed/{tipo}/{órgão}.xml
As últimas 50 edições de um órgão. O endereço é o da página do órgão com /feed na frente e .xml no fim — por exemplo, /feed/prefeitura/conceicao-do-coite.xml.
API
Endereço base: https://domunicipio.com/api/v1. As respostas são JSON em UTF-8, podem ser lidas de qualquer site (CORS aberto) e ficam um minuto em cache.
GET/api/v1/organs
Os órgãos que publicam aqui: identificador, tipo, nome, contato, lei que instituiu o Diário, endereço da página, do feed e da planilha, total de edições.
GET/api/v1/editions?organ={id}&year={ano}&type={ordinaria|extraordinaria}&page={n}&per_page={n}
Edições, das mais recentes para as mais antigas. Todos os filtros são opcionais; per_page vai até 100.
GET/api/v1/editions/{id}
Uma edição, com os arquivos: endereço do PDF, número de páginas, tamanho, o sha256 do arquivo e o que o site leu da assinatura digital (signature).
GET/api/v1/editions/{id}/text
O texto da edição em arquivo .txt (UTF-8), página por página. É a leitura automática do PDF — o documento oficial é o PDF.
GET/api/v1/editions.csv?organ={id}&year={ano}&type={ordinaria|extraordinaria}
A lista de edições em planilha: CSV com separador ; e UTF-8 com BOM, que abre direto no Excel e no LibreOffice. Os mesmos filtros da lista em JSON, sem paginação.
GET/api/v1/search?q={termo}&organ={id}&year={ano}&page={n}
Busca no texto completo. Cada resultado traz as páginas do PDF em que o termo aparece, com o trecho e o endereço que abre o documento naquela página. Aspas procuram a frase exata.
Widget para o site do órgão
Um bloco com as últimas edições e uma busca, para colar no site da prefeitura, da câmara ou da autarquia. Ele se atualiza sozinho a cada edição publicada. Cole este código onde o bloco deve aparecer:
<div data-diario="prefeitura/nome-do-municipio" data-limit="6"></div> <script async src="https://domunicipio.com/embed.js"></script>
- Em
data-diariovai o endereço da página do órgão aqui no Diário, sem a barra inicial (por exemplo,camara/conceicao-do-coite). data-limité o número de edições (de 1 a 20). Para fundo escuro, acrescentedata-theme="dark".- O site não aceita script? Use só um
<iframe>apontando parahttps://domunicipio.com/embed/prefeitura/nome-do-municipio.
O que significa cada campo
| Campo | Onde | Significado |
|---|---|---|
id | órgão, edição | Identificador estável. O da edição é o mesmo do endereço /edition/{id}. |
type | órgão | prefeitura, camara ou autarquia. |
address, phone, email | órgão | Contato do órgão, como ele cadastrou. |
website, transparency_url, opening_hours | órgão | Site oficial, portal da transparência e horário de atendimento, quando conhecidos. |
gazette_law | órgão | Lei municipal que instituiu o Diário Oficial do órgão, quando informada. |
editions_csv_url | órgão | Endereço da planilha com todas as edições do órgão. |
type | edição | ordinaria ou extraordinaria. |
number | edição | Número da edição. Nulo quando a origem não informa. |
published_on | edição | Data da edição. |
uploaded_at | edição | Instante em que a edição foi recebida e ficou disponível. |
summary | edição | Os atos da edição, um por item, como o órgão informou. |
pages | edição, arquivo | Número de páginas do PDF. |
sha256 | arquivo | Código do arquivo: confere se o PDF baixado é o publicado. |
text_url | arquivo | Endereço do texto em .txt. Nulo quando o PDF é só imagem digitalizada. |
signature.status | arquivo | signed (traz assinatura embutida), unsigned (não traz) ou nulo (ainda não conferido). |
signature.signatures[] | arquivo | Para cada assinatura: signatário, documento, autoridade certificadora, se é ICP-Brasil, tipo do certificado, instante, se cobre o arquivo inteiro e se o conteúdo confere (intact; nulo = não foi possível conferir). |
Formatos: JSON (API), XML (RSS), CSV (planilha), TXT (texto da edição) e PDF (documento oficial). Datas em AAAA-MM-DD; instantes em ISO 8601, no horário universal (UTC).
Regras de uso
- Uso livre. Os documentos são atos oficiais, públicos por lei: podem ser copiados, reutilizados e redistribuídos, inclusive para fins comerciais, sem pedir autorização. Cite o órgão e a edição.
- Não é preciso cadastro, chave nem identificação.
- O documento oficial é sempre o PDF assinado. O texto extraído (busca e trechos) é uma leitura automática e pode conter falhas, em especial em páginas digitalizadas.
- A busca tem limite de requisições por minuto. Para baixar o acervo, percorra
/api/v1/editionse use os endereços dos PDFs — não a busca. - Os campos existentes não mudam de nome nem de sentido; campos novos podem ser acrescentados.
A validade jurídica da assinatura é atestada pelo validador do ITI (validar.iti.gov.br); o campo signature é só o que o site leu do arquivo. Dúvidas ou necessidade de outro formato: diario@domunicipio.com.