DADOS ABERTOS » WebService voltar

Os dados abertos podem ser acessados a qualquer momento em JSON ou XML e são atualizados automaticamente de acordo com o Portal da Transparência. Todas as informações referentes à execução orçamentária estão disponíveis.

API

Parâmetros comuns [topo]

Todos os endpoints da API possuem em comum os parâmetros abaixo:

Parâmetro Tipo Obrigatoriedade Descrição
type string Obrigatório Tipo de retorno dos dados (json ou xml), caso não informado ou incorreto o valor padrão será json
page inteiro Obrigatório Página atual a exibir, caso não informado ou incorreto o valor padrão será 1
page_size inteiro Opcional Quantidade de registros da página (Mínimo 1, máximo 100), caso não informado ou incorreto o valor padrão será 10

Retornos comuns [topo]

Todos os endpoints da API possuem em comum os retornos abaixo:

Parâmetro Tipo Descrição
pagina_total inteiro Retorna o número total de páginas
pagina_atual inteiro Retorna o número da página em exibição
pagina_anterior inteiro Retorna o número da página anterior, caso não houver, o valor null será retornado
pagina_proxima inteiro Retorna o número da próxima página, caso não houver, o valor null será retornado
registro_total inteiro Retorna o número total de registros
registro_atual inteiro Retorna o número de registros da página atual

Contratações [topo]

Endpoint: https://www.pmbsf.es.gov.br/transparencia/api/contratos

PARÂMETROS DE ENTRADA
Parâmetro Tipo Obrigatoriedade Descrição
tipo inteiro Opcional Tipo de contratação
numero inteiro Opcional Número do contrato
ano inteiro Opcional Ano do contrato
entidade inteiro Opcional ID da entidade (Unidade Gestora)
modalidade inteiro Opcional ID da modalidade licitatória
situacao inteiro Opcional ID da situação
data_inicio data Opcional Data inicial da delimitação temporal da consulta, formato dd/mm/aaaa
data_fim data Opcional Data final da delimitação temporal da consulta, formato dd/mm/aaaa
categoria inteiro Opcional ID da categoria
busca string Opcional Busca geral
id inteiro Opcional ID do registro a ser retornado
PARÂMETROS DE SAÍDA - DICIONÁRIO DE DADOS
Parâmetro Tipo Descrição
registros id inteiro ID do registro
tipo inteiro Tipo de contratação
contrato_numero inteiro Número da contratação
ano inteiro Ano da contratação
entidade string Entidade (Unidade Gestora)
objeto texto Objeto da contratação
valor decimal Valor da contratação
fornecedor_nome string Nome do Fornecedor
fornecedor_documento string CPF/CNPJ do Fornecedor
categoria string Categoria
situacao string Situação
data_assinatura data Data de assinatura
data_celebracao data Data da celebração
data_publicacao_diario_oficial data Data da publicação no Diário Oficial
numero_diario_oficial string Número da publicação no Diário Oficial
link_diario_oficial string Link da publicação no Diário Oficial
duracao string Duração da contratação
vigencia_data_inicio data Data de início da vigência da contratação
vigencia_data_fim data Data de término da vigência da contratação
modalidade string Modalidade Licitatória
processo string Número do Processo
ata string Número da Ata
licitacao string Número da Licitação
empenho string Número do Empenho
fiscal string Fiscal da contratação
orgao_contratante string Órgão(s) contratante(s)
local_execucao string Local da execução
bens lista
Parâmetro Tipo Descrição
data_aquisicao data Data de aquisição do bem/produto
identificacao string Descrição do bem/produto
fornecedor_nome string Nome do Fornecedor
fornecedor_documento string CPF/CNPJ do Fornecedor
orgao_adquirente string Órgão Adquirente
valor_unitario decimal Valor unitário
quantidade decimal Quantidade
unidade_medida string Unidade de medida
valor_total decimal Valor total
documentos lista
Parâmetro Tipo Descrição
descricao string Descrição
arquivo string URL do arquivo
aditivos lista
Parâmetro Tipo Descrição
numero string Número do Aditivo
valor decimal Valor
vigencia_data_inicio data Data de início da vigência do aditivo
vigencia_data_fim data Data de término da vigência do aditivo
descricao texto Descrição
arquivo string URL do arquivo
tipos id inteiro ID do tipo
nome string Nome do tipo
entidades id inteiro ID da entidade
nome string Nome da entidade
modalidades id inteiro ID da modalidade
nome string Nome da modalidade
situacoes id inteiro ID da situação
nome string Nome da situação
categorias id inteiro ID da categoria
nome string Nome da categoria