Skip to content

endpoints.md

Latest commit

 

History

History
1073 lines (932 loc) · 51.1 KB

endpoints.md

File metadata and controls

1073 lines (932 loc) · 51.1 KB
Raw

API REST — referencia dos 106 endpoints

Exige chave no header chave-api-dados (gratuita, via conta gov.br nivel prata/ouro em https://portaldatransparencia.gov.br/api-de-dados/cadastrar-email). Limite: 400 req/min (700 entre 0h e 6h); estourar suspende o token por 8h. Base: https://api.portaldatransparencia.gov.br. Chamada: pt.py api <path> chave=valor ....

Sem chave, prefira o download em massa (veja SKILL.md) — cobre a maior parte dos temas sem cadastro. Campos de retorno de cada DTO em schemas.md.

Viagens a serviço

GET /api-de-dados/viagens

Consulta viagens por período

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Período de no máximo 1 mês; Código do Órgão (SIAFI)
  • Obrigatórios:
    • dataIdaDe (query, string) — Data de ida a partir de (DD/MM/AAAA)
    • dataIdaAte (query, string) — Data de ida até (DD/MM/AAAA)
    • dataRetornoDe (query, string) — Data de retorno a partir de (DD/MM/AAAA)
    • dataRetornoAte (query, string) — Data de retorno até (DD/MM/AAAA)
    • codigoOrgao (query, string) — Código do Órgão (SIAFI)
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ViagemDTO>

GET /api-de-dados/viagens/{id}

Consulta uma viagem pelo ID

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (path, integer) — ID do registro
  • Retorna: ViagemDTO

GET /api-de-dados/viagens-por-cpf

Consulta viagens por CPF

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); CPF;
  • Obrigatórios:
    • cpf (query, string) — CPF
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ViagemDTO>

Imóveis Funcionais

GET /api-de-dados/situacao-imovel

Consulta situações dos imóveis funcionais

  • Retorna: array<string>

GET /api-de-dados/permissionarios

Consulta relação de ocupantes

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • codigoOrgaoResponsavelGestaoSiafi (query, string) — Código do Órgão Responsável pela Gestão(SIAFI)
    • descricaoOrgaoOcupante (query, string) — Descrição do Órgão do Ocupante
    • cpfOcupante (query, string) — CPF Ocupante
    • dataInicioOcupacao (query, string) — Data início ocupação(DD/MM/AAAA)
    • dataFimOcupacao (query, string) — Data fim ocupação (DD/MM/AAAA)
  • Retorna: array<PermissionarioDTO>

GET /api-de-dados/imoveis

Consulta relação de imóveis

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • codigoOrgaoSiafiResponsavelGestao (query, string) — Código do Órgão (SIAFI)
    • situacao (query, string) — Situação Imóvel
    • regiao (query, string) — Região
    • cep (query, string) — CEP
    • endereco (query, string) — Endereço
  • Retorna: array<ImovelFuncionalDTO>

Servidores do Poder Executivo Federal

GET /api-de-dados/servidores

Consulta todos servidores do Poder Executivo Federal

GET /api-de-dados/servidores/{id}

Consulta um servidor do Poder Executivo Federal pelo idServidorAposentadoPensionista

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (path, integer) — idServidorAposentadoPensionista
  • Retorna: CadastroServidorDTO

GET /api-de-dados/servidores/remuneracao

Consulta remunerações de um servidor do Poder Executivo Federal pelo CPF ou idServidorAposentadoPensionista e mês/ano

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); CPF; Ano/Mês (YYYYMM); ou Página (padrão = 1); Id Servidor; Ano/Mês (YYYYMM);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • id (query, integer) — idServidorAposentadoPensionista
    • cpf (query, string) — CPF do Servidor
  • Retorna: array<ServidorRemuneracaoDTO>

GET /api-de-dados/servidores/por-orgao

Consulta de servidores agregados por órgão

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • orgaoLotacao (query, string) — Código Órgão Lotação (SIAPE)
    • orgaoExercicio (query, string) — Código Órgão Exercício (SIAPE)
    • tipoServidor (query, integer) — Tipo servidor (Civil: 1; Militar: 2)
    • tipoVinculo (query, integer) — Tipo vínculo (Função: 1; Cargo: 2; Outros: 3; Militares: 4
    • licenca (query, integer) — Licença (Sim: 1; Não: 0)
  • Retorna: array<ServidorPorOrgaoDTO>

GET /api-de-dados/servidores/funcoes-e-cargos

Código da Função ou Cargo de Confiança

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<FuncaoServidorDTO>

GET /api-de-dados/peps

Consulta PEPs

  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • cpf (query, string) — CPF do Servidor
    • nome (query, string) — Nome do Servidor
    • descricaoFuncao (query, string) — Descrição da Função
    • orgaoServidorLotacao (query, string) — Código Órgão Lotação (SIAPE)
    • dataInicioExercicioDe (query, string) — Data início do exercício, período inicial (DD/MM/AAAA)
    • datInicioExercicioAte (query, string) — Data início do exercício, período final (DD/MM/AAAA)
    • dataFimExercicioDe (query, string) — Data fim do exercício, período inicial (DD/MM/AAAA)
    • datFimExercicioAte (query, string) — Data fim do exercício, período final (DD/MM/AAAA)
  • Retorna: array<PEPDTO>

Benefícios

GET /api-de-dados/seguro-defeso-por-municipio

Consulta os registros Seguro Defeso

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BeneficioPorMunicipioDTO>

GET /api-de-dados/seguro-defeso-codigo

Consulta os registros Seguro Defeso por CPF/NIS

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); CPF / NIS;
  • Obrigatórios:
    • codigo (query, string) — CPF/NIS
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<SeguroDefesoDTO>

GET /api-de-dados/seguro-defeso-beneficiario-por-municipio

Consulta os registros Seguro Defeso dos Beneficiários por Município e Mes/Ano

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<SeguroDefesoDTO>

GET /api-de-dados/safra-por-municipio

Consulta os registros Garantia-Safra

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BeneficioPorMunicipioDTO>

GET /api-de-dados/safra-codigo-por-cpf-ou-nis

Consulta os registros Garantia-Safra por CPF/NIS

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); CPF / NIS;
  • Obrigatórios:
    • codigo (query, string) — CPF/NIS
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<SafraDTO>

GET /api-de-dados/safra-beneficiario-por-municipio

Consulta os registros Garantia-Safra dos beneficiários por município e mes/ano

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<SafraDTO>

GET /api-de-dados/peti-por-municipio

Consulta os registros Programa de Erradicação do Trabalho Infantil

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BeneficioPorMunicipioDTO>

GET /api-de-dados/peti-por-cpf-ou-nis

Consulta os registros Programa de Erradicação do Trabalho Infantil por CPF/NIS

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); CPF / NIS;
  • Obrigatórios:
    • codigo (query, string) — CPF/NIS
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<PetiDTO>

GET /api-de-dados/peti-beneficiario-por-municipio

Consulta os registros PETI dos beneficiários por município e mês/ano

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<PetiDTO>

GET /api-de-dados/novo-bolsa-familia-sacado-por-nis

  • Obrigatórios:
    • nis (query, string) —
  • Opcionais:
    • anoMesReferencia (query, integer) —
    • anoMesCompetencia (query, integer) —
    • pagina (query, integer (default=1)) —
  • Retorna: array<NovoBolsaFamiliaPagoDTO>

GET /api-de-dados/novo-bolsa-familia-sacado-beneficiario-por-municipio

  • Obrigatórios:
    • mesAno (query, integer) —
    • codigoIbge (query, string) —
  • Opcionais:
    • pagina (query, integer (default=1)) —
  • Retorna: array<NovoBolsaFamiliaPagoDTO>

GET /api-de-dados/novo-bolsa-familia-por-municipio

  • Obrigatórios:
    • mesAno (query, integer) —
    • codigoIbge (query, string) —
  • Opcionais:
    • pagina (query, integer (default=1)) —
  • Retorna: array<BeneficioPorMunicipioDTO>

GET /api-de-dados/bpc-por-municipio

Consulta os registros de Benefício de Prestação Continuada por Município

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BeneficioPorMunicipioDTO>

GET /api-de-dados/bpc-por-cpf-ou-nis

Consulta os registros de Benefício de Prestação Continuada por CPF/NIS

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); CPF / NIS;
  • Obrigatórios:
    • codigo (query, string) — CPF/NIS
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BPCDTO>

GET /api-de-dados/bpc-beneficiario-por-municipio

Consulta os registros de Benefício de Prestação Continuada dos Beneficiários por Município e Mes/Ano

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BPCDTO>

GET /api-de-dados/bolsa-familia-sacado-por-nis

Consulta as parcelas sacadas pelo Bolsa Família pelo NIS

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); NIS; Ano e mês de competência (AAAAMM) ou Ano e mês de referência (AAAAMM);
  • Obrigatórios:
    • nis (query, string) — NIS (sem máscara, somente números)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • anoMesReferencia (query, integer) — Ano e mês de referência (AAAAMM)
    • anoMesCompetencia (query, integer) — Ano e mês de competência (AAAAMM)
  • Retorna: array<BolsaFamiliaPagoDTO>

GET /api-de-dados/bolsa-familia-sacado-beneficiario-por-municipio

Consulta as parcelas do Bolsa Família Sacado dos Beneficiários por Município e Mes/Ano

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BolsaFamiliaPagoDTO>

GET /api-de-dados/bolsa-familia-por-municipio

Consulta as parcelas do Bolsa Família por Município

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BeneficioPorMunicipioDTO>

GET /api-de-dados/bolsa-familia-disponivel-por-cpf-ou-nis

Consulta as parcelas disponibilizadas pelo Bolsa Família pelo CPF/NIS

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); CPF / NIS; Ano e mês de competência (AAAAMM) ou Ano e mês de referência (AAAAMM);
  • Obrigatórios:
    • codigo (query, string) — CPF/NIS (sem máscara, somente números)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • anoMesReferencia (query, integer) — Ano e mês de referência (AAAAMM)
    • anoMesCompetencia (query, integer) — Ano e mês de competência (AAAAMM)
  • Retorna: array<BolsaFamiliaDTO>

GET /api-de-dados/bolsa-familia-disponivel-beneficiario-por-municipio

Consulta as parcelas do Bolsa Família Disponível dos Beneficiários por Município e Mes/Ano

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BolsaFamiliaDTO>

GET /api-de-dados/auxilio-emergencial-por-municipio

Consulta os registros de auxílio emergencial por Município

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BeneficioPorMunicipioDTO>

GET /api-de-dados/auxilio-emergencial-por-cpf-ou-nis

Consulta os registros de auxílio emergencial por CPF/NIS

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); CPF / NIS;
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • codigoBeneficiario (query, string) — CPF/NIS Beneficiário
    • codigoResponsavelFamiliar (query, string) — CPF/NIS Responsável Familiar
  • Retorna: array<AuxilioEmergencialDTO>

GET /api-de-dados/auxilio-emergencial-beneficiario-por-municipio

Consulta os registros dos beneficiários por município e mês/ano

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<AuxilioEmergencialDTO>

GET /api-de-dados/auxilio-brasil-sacado-por-nis

Consulta as parcelas disponibilizadas pelo Auxílio Brasil pelo NIS

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); NIS; Ano e mês de competência (AAAAMM) ou Ano e mês de referência (AAAAMM);
  • Obrigatórios:
    • nis (query, string) — NIS (sem máscara, somente números)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • anoMesReferencia (query, integer) — Ano e mês de referência (AAAAMM)
    • anoMesCompetencia (query, integer) — Ano e mês de competência (AAAAMM)
  • Retorna: array<AuxilioBrasilPagoDTO>

GET /api-de-dados/auxilio-brasil-sacado-beneficiario-por-municipio

Consulta as parcelas do Auxílio Brasil Sacado dos Beneficiários por Município e Mes/Ano

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<AuxilioBrasilPagoDTO>

GET /api-de-dados/auxilio-brasil-por-municipio

Consulta as parcelas do Auxílio Brasil por Município

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano/Mês (YYYYMM); Código IBGE (https://cidades.ibge.gov.br/brasil);
  • Obrigatórios:
    • mesAno (query, integer) — Ano e mês de referência (AAAAMM)
    • codigoIbge (query, string) — Código IBGE
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<BeneficioPorMunicipioDTO>

Renúncias Fiscais

GET /api-de-dados/renuncias-valor

Consulta de Valores Renunciados

  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • nomeSiglaUF (query, string) — Nome ou Sigla UF
    • codigoIbge (query, string) — Código IBGE
    • cnpj (query, string) — CNPJ
  • Retorna: array<RenunciaDTO>

GET /api-de-dados/renuncias-fiscais-empresas-imunes-isentas

Consulta Pessoas Jurídicas Imunes e Isentas

  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • nomeSiglaUF (query, string) — Nome ou Sigla UF
    • codigoIbge (query, string) — Código IBGE
    • cnpj (query, string) — CNPJ
    • beneficiarioNomeFantasia (query, string) — Beneficiário/Nome Fantasia
  • Retorna: array<EmpresaImuneIsentaDTO>

GET /api-de-dados/renuncias-fiscais-empresas-habilitadas-beneficios-fiscais

Consulta Pessoas Jurídicas Habilitadas a Benefício Fiscal

  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • nomeSiglaUF (query, string) — Nome ou Sigla UF
    • codigoIbge (query, string) — Código IBGE
    • cnpj (query, string) — CNPJ
    • beneficiarioNomeFantasia (query, string) — Beneficiário/Nome Fantasia
  • Retorna: array<EmpresaHabilitadaBeneficioFiscalDTO>

Pessoas físicas e jurídicas

GET /api-de-dados/pessoa-juridica

Consulta os registros de Pessoas Jurídicas

  • Obrigatórios:
    • cnpj (query, string) — CNPJ
  • Retorna: PessoaJuridicaDTO

GET /api-de-dados/pessoa-fisica

Consulta os registros de Pessoas Físicas

  • Filtros/regras: Filtros mínimos: CPF ou NIS
  • Opcionais:
    • cpf (query, string) — CPF
    • nis (query, string) — NIS
  • Retorna: PessoaFisicaDTO

Órgãos

GET /api-de-dados/orgaos-siape

Consulta de órgãos cadastrados no Sistema Integrado de Administração de Pessoal (SIAPE)

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Período de no máximo 1 mês;
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • codigo (query, string) — Código do Órgão (SIAPE)
    • descricao (query, string) — Descrição do Órgão (SIAPE)
  • Retorna: array<CodigoDescricaoDTO>

GET /api-de-dados/orgaos-siafi

Consulta de órgãos cadastrados no Sistema Integrado de Administração Financeira do Governo Federal (SIAFI)

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • codigo (query, string) — Código do Órgão (SIAFI)
    • descricao (query, string) — Descrição do Órgão (SIAFI)
  • Retorna: array<CodigoDescricaoDTO>

Notas Fiscais

GET /api-de-dados/notas-fiscais

Consulta todas as notas fiscais eletrônicas (NFe´s) do Poder Executivo Federal

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); CNPJ Emitente / Órgão / Produto;
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • cnpjEmitente (query, string) — CNPJ do emitente
    • codigoOrgao (query, string) — Código do Órgão (SIAFI)
    • nomeProduto (query, string) — Nome do produto
  • Retorna: array<NotaFiscalDTO>

GET /api-de-dados/notas-fiscais-por-chave

Consulta uma nota fiscal eletrônica (NFe) do Poder Executivo Federal pela chave única

  • Filtros/regras: Filtros mínimos: Código do registro
  • Obrigatórios:
    • chaveUnicaNotaFiscal (query, string) — Chave única da nota fiscal
  • Retorna: DetalheNotaFiscalDTO

Licitações do Poder Executivo Federal

GET /api-de-dados/licitacoes

Consulta todas as licitações do Poder Executivo Federal

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Período de no máximo 1 mês; Código do Órgão (SIAFI)
  • Obrigatórios:
  • Opcionais:
    • dataInicial (query, string) — Data de abertura inicial (DD/MM/AAAA)
    • dataFinal (query, string) — Data de abertura final (DD/MM/AAAA)
  • Retorna: array<LicitacaoDTO>

GET /api-de-dados/licitacoes/{id}

Consulta uma licitação do Poder Executivo Federal pelo id

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (path, integer) — ID do registro
  • Retorna: LicitacaoDTO

GET /api-de-dados/licitacoes/ugs

Consulta as Unidades Gestoras que realizaram licitações

  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<UnidadeGestoraDTO>

GET /api-de-dados/licitacoes/por-ug-modalidade-numero

Consulta uma licitação pelo código da Unidade Gestora, número e modalidade

  • Filtros/regras: O número da licitação deve conter somente números, por exemplo, para a licitação 2/2020 o parâmetro deve ter o valor 22020
  • Obrigatórios:
  • Retorna: array<LicitacaoDTO>

GET /api-de-dados/licitacoes/por-processo

Consulta uma licitação pelo número do processo

  • Filtros/regras: O número do processo deve conter somente números
  • Obrigatórios:
    • processo (query, string) — Número do Processo
  • Retorna: array<LicitacaoDTO>

GET /api-de-dados/licitacoes/participantes

Consulta os participantes de uma licitação

  • Filtros/regras: O número da licitação deve conter somente números, por exemplo, para a licitação 2/2020 o parâmetro deve ter o valor 22020
  • Obrigatórios:
  • Retorna: array<ParticipanteLicitacaoDTO>

GET /api-de-dados/licitacoes/modalidades

Consulta as modalidades de licitação

  • Retorna: array<CodigoDescricaoDTO>

GET /api-de-dados/licitacoes/itens-licitados

Consulta os itens licitados pelo id licitação

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (query, integer) — ID do registro
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ItemLicitacaoDTO>

GET /api-de-dados/licitacoes/empenhos

Consulta os empenhos de uma licitação

  • Filtros/regras: O número da licitação deve conter somente números, por exemplo, para a licitação 2/2020 o parâmetro deve ter o valor 22020
  • Obrigatórios:
  • Retorna: array<EmpenhoComprasDTO>

GET /api-de-dados/licitacoes/contratos-relacionados-licitacao

Consulta os contratos relacionados a licitação

Emendas parlamentares

GET /api-de-dados/emendas

Consulta as emendas parlamentares

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • codigoEmenda (query, string) — Código da Emenda
    • numeroEmenda (query, string) — Número da emenda
    • nomeAutor (query, string) — Nome do Autor
    • tipoEmenda (query, string) — Tipo de emenda
    • ano (query, integer) — Ano
    • codigoFuncao (query, string) — Código da função
    • codigoSubfuncao (query, string) — Código da subfunção
  • Retorna: array<ConsultaEmendasDTO>

GET /api-de-dados/emendas/documentos/{codigo}

Consulta os documentos relacionados à emenda parlamentar pelo código da emenda

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • codigo (path, string) — Código da emenda
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<DocumentoRelacionadoEmendaDTO>

Despesas Públicas

GET /api-de-dados/despesas/tipo-transferencia

Consulta os tipos de transferências usados nas despesas

  • Retorna: array<IdDescricaoDTO>

GET /api-de-dados/despesas/recursos-recebidos

Recebimento de recursos por favorecido

  • Obrigatórios:
    • mesAnoInicio (query, string) — Mês ano início (MM/AAAA)
    • mesAnoFim (query, string) — Mês ano fim (MM/AAAA)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • nomeFavorecido (query, string) — Nome Favorecido
    • codigoFavorecido (query, string) — CNPJ / CPF / Código do favorecido
    • tipoFavorecido (query, string) — Tipo de favorecido
    • uf (query, string) — Sigla UF
    • codigoIBGE (query, string) — Município
    • orgaoSuperior (query, string) — Órgão superior (código SIAFI)
    • orgao (query, string) — Órgão/Entidade vinculada (código SIAFI)
    • unidadeGestora (query, string) — Unidade gestora (código SIAFI)
  • Retorna: array<PessoaRecursosRecebidosUGMesDesnormalizadaDTO>

GET /api-de-dados/despesas/por-orgao

Consulta as despesas dos órgão do Poder Executivo Federal

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano do registro; Ao menos um dos demais filtros;
  • Obrigatórios:
    • ano (query, integer) — Ano da despesa (AAAA)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • orgaoSuperior (query, string) — Órgão superior (código SIAFI)
    • orgao (query, string) — Órgão/Entidade vinculada (código SIAFI)
  • Retorna: array<DespesaAnualPorOrgaoDTO>

GET /api-de-dados/despesas/por-funcional-programatica

Consulta as despesas do Poder Executivo Federal pela classificação funcional programática

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano do registro; Ao menos um dos demais filtros;
  • Obrigatórios:
    • ano (query, integer) — Ano da despesa (AAAA)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • funcao (query, string) — Função (código SIAFI)
    • subfuncao (query, string) — Subfunção (código SIAFI)
    • programa (query, string) — Programa (código SIAFI)
    • acao (query, string) — Ação (código SIAFI)
  • Retorna: array<DespesaAnualPorFuncaoESubfuncaoDTO>

GET /api-de-dados/despesas/por-funcional-programatica/movimentacao-liquida

Consulta de movimentação líquida anual das despesas do Poder Executivo Federal pela classificação funcional programática

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano do registro; Ao menos um dos demais filtros;
  • Obrigatórios:
    • ano (query, integer) — Ano da despesa (AAAA)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • funcao (query, string) — Função (código SIAFI)
    • subfuncao (query, string) — Subfunção (código SIAFI)
    • programa (query, string) — Programa (código SIAFI)
    • acao (query, string) — Ação (código SIAFI)
    • grupoDespesa (query, string) — Grupo Despesa (código SIAFI)
    • elementoDespesa (query, string) — Elemento Despesa (código SIAFI)
    • modalidadeAplicacao (query, string) — Modalidade de Aplicação (código SIAFI)
    • idPlanoOrcamentario (query, integer) — Id Plano orçamentário
  • Retorna: array<DespesaLiquidaAnualPorFuncaoESubfuncaoDTO>

GET /api-de-dados/despesas/plano-orcamentario

Consulta Plano orçamentário

  • Obrigatórios:
    • ano (query, integer) — Ano
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • codPlanoOrcamentario (query, string) — Código Plano Orçamentária
    • descPlanoOrcamentario (query, string) — Descrição Plano Orçamentário
    • codPOIdentfAcompanhamento (query, string) — Identificado de acompanhamento
  • Retorna: array<DespesasPorPlanoOrcamentarioDTO>

GET /api-de-dados/despesas/itens-de-empenho

Consulta os itens de um Empenho

  • Obrigatórios:
    • codigoDocumento (query, string) — Código do empenho (Unidade Gestora + Gestão + Número do documento)
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<DetalhamentoDoGastoDTO>

GET /api-de-dados/despesas/itens-de-empenho/historico

Consulta o histórico de um item de empenho

  • Obrigatórios:
    • codigoDocumento (query, string) — Código do empenho (Unidade Gestora + Gestão + Número do documento)
    • sequencial (query, integer) — Número sequencial do item de empenho
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<HistoricoSubItemEmpenhoDTO>

GET /api-de-dados/despesas/favorecidos-finais-por-documento

Consulta favorecidos finais por documento

  • Filtros/regras: Filtros mínimos: Código do registro
  • Obrigatórios:
    • codigoDocumento (query, string) — Código do documento (Unidade Gestora + Gestão + Número do documento)
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ConsultaFavorecidosFinaisPorDocumentoDTO>

GET /api-de-dados/despesas/empenhos-impactados

Consulta empenhos impactados por documento/fase

  • Filtros/regras: Filtros mínimos: Código do registro e fase da despesa (liquidação ou pagamento somente)
  • Obrigatórios:
    • codigoDocumento (query, string) — Código do documento (Unidade Gestora + Gestão + Número do documento)
    • fase (query, integer) — Fase da despesa (2 - Liquidação, 3 - Pagamento)
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<EmpenhoImpactadoBasicoDTO>

GET /api-de-dados/despesas/documentos

Consulta todos os documentos de despesas

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Período de no máximo 1 dia; Fase da despesa; Ao menos um dos demais filtros;
  • Obrigatórios:
    • dataEmissao (query, string) — Data de emissão (DD/MM/AAAA)
    • fase (query, integer) — Fase da despesa (1 - Empenho, 2 - Liquidação, 3 - Pagamento)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • unidadeGestora (query, string) — Unidade gestora emitente (código SIAFI)
    • gestao (query, string) — Gestão (código SIAFI)
  • Retorna: array<DespesasPorDocumentoDTO>

GET /api-de-dados/despesas/documentos/{codigo}

Consulta um documento pelo código (Unidade Gestora + Gestão + Número do documento)

  • Filtros/regras: Filtros mínimos: Código do registro
  • Obrigatórios:
    • codigo (path, string) — Código do registro
  • Retorna: DespesasPorDocumentoDTO

GET /api-de-dados/despesas/documentos-relacionados

Consulta os documentos relacionados a um Empenho, Liquidação ou Pagamento

  • Obrigatórios:
    • codigoDocumento (query, string) — Código do documento (Unidade Gestora + Gestão + Número do documento)
    • fase (query, integer) — Fase da despesa (1 - Empenho, 2 - Liquidação, 3 - Pagamento)
  • Retorna: array<DocumentoRelacionadoDTO>

GET /api-de-dados/despesas/documentos-por-favorecido

Consulta Empenhos, Liquidações e Pagamentos emitidos para um favorecido

  • Filtros/regras: A informação favorecidoIntermediario indica se o documento foi emitido para o favorecido ou se ele é apenas um intermediário que recebe o recurso e repassa-o para os favorecidos finais
  • Obrigatórios:
    • codigoPessoa (query, string) — Código do Favorecido (CPF, CNPJ ou código do SIAFI)
    • fase (query, integer) — Fase da despesa (1 - Empenho, 2 - Liquidação, 3 - Pagamento)
    • ano (query, integer) — Ano de emissão do documento
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • ug (query, string) — Código da unidade gestora emissora do documento
    • gestao (query, string) — Código da gestão do documento
    • ordenacaoResultado (query, integer) — Ordenação de Resultado (1 - Valor Ascendente, 2 - Valor Descendente, 3 - Data Ascendente, 4 - Data Descendente)
  • Retorna: array<DespesasPorDocumentoDTO>

api-funcional-programatica-controller

GET /api-de-dados/despesas/funcional-programatica/subfuncoes

  • Obrigatórios:
    • anoInicio (query, integer) —
    • pagina (query, integer) —
  • Opcionais:
    • codigo (query, string) —
  • Retorna: array<DimFuncionalProgramaticaDTO>

GET /api-de-dados/despesas/funcional-programatica/programas

  • Obrigatórios:
    • anoInicio (query, integer) —
    • pagina (query, integer) —
  • Opcionais:
    • codigo (query, string) —
  • Retorna: array<DimFuncionalProgramaticaDTO>

GET /api-de-dados/despesas/funcional-programatica/listar

  • Obrigatórios:
    • ano (query, integer) —
    • pagina (query, integer) —
  • Retorna: array<FuncionalProgramaticaDTO>

GET /api-de-dados/despesas/funcional-programatica/funcoes

  • Obrigatórios:
    • anoInicio (query, integer) —
    • pagina (query, integer) —
  • Opcionais:
    • codigo (query, string) —
  • Retorna: array<DimFuncionalProgramaticaDTO>

GET /api-de-dados/despesas/funcional-programatica/acoes

  • Obrigatórios:
    • anoInicio (query, integer) —
    • pagina (query, integer) —
  • Opcionais:
    • codigo (query, string) —
  • Retorna: array<DimFuncionalProgramaticaDTO>

Coronavírus

GET /api-de-dados/coronavirus/transferencias

Consulta de transferências mensal das despesas do Poder Executivo Federal pela classificação funcional programática

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano do registro; Ao menos um dos demais filtros;
  • Obrigatórios:
    • mesAno (query, integer) — Mês e Ano (AAAAMM)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • codigoOrgao (query, string) — Órgão (código SIAFI)
    • tipoTransferencia (query, integer) — ID do Tipo de Transferência
    • uf (query, string) — Sigla UF
    • codigoIbge (query, string) — Município
  • Retorna: array<TransferenciaCoronavirusDTO>

GET /api-de-dados/coronavirus/movimento-liquido-despesa

Consulta de movimentação líquida mensal das despesas do Poder Executivo Federal pela classificação funcional programática

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Ano do registro; Ao menos um dos demais filtros;
  • Obrigatórios:
    • mesAnoLancamento (query, integer) — Mês e Ano de lançamento (AAAAMM)
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • funcao (query, string) — Função (código SIAFI)
    • subfuncao (query, string) — Subfunção (código SIAFI)
    • programa (query, string) — Programa (código SIAFI)
    • acao (query, string) — Ação (código SIAFI)
    • grupoDespesa (query, string) — Grupo Despesa (código SIAFI)
    • elementoDespesa (query, string) — Elemento Despesa (código SIAFI)
    • modalidadeAplicacao (query, string) — Modalidade de Aplicação (código SIAFI)
    • idPlanoOrcamentario (query, integer) — Id Plano orçamentário
  • Retorna: array<MovimentacaoLiquidaCovidDTO>

Convênios do Poder Executivo Federal

GET /api-de-dados/convenios

Consulta todos convênios do Poder Executivo Federal

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Período de no máximo 1 dia;
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • dataInicial (query, string) — Data referência início (DD/MM/AAAA)
    • dataFinal (query, string) — Data referência fim (DD/MM/AAAA)
    • dataUltimaLiberacaoInicial (query, string) — Data da última liberação de recurso início (DD/MM/AAAA)
    • dataUltimaLiberacaoFinal (query, string) — Data da última liberação de recurso fim (DD/MM/AAAA)
    • dataVigenciaInicial (query, string) — Data de vigência início (DD/MM/AAAA)
    • dataVigenciaFinal (query, string) — Data de vigência fim (DD/MM/AAAA)
    • convenente (query, string) — Convenente
    • tipoConvenente (query, string) — Tipo de Convenente
    • numero (query, string) — Número do convênio
    • numeroOriginal (query, string) — Número original do convênio
    • codigoOrgao (query, string) — Código do Órgão (SIAFI)
    • uf (query, string) — Sigla UF
    • codigoIBGE (query, string) — Município (Código IBGE)
    • situacao (query, string) — Código Situação
    • tipoInstrumento (query, string) — Código Tipo de Instrumento
    • funcao (query, string) — Código Função
    • subfuncao (query, string) — Código Subfunção
    • valorLiberadoDe (query, string) — Valor liberado de (Formato: 1.000,00)
    • valorLiberadoAte (query, string) — Valor liberado até (Formato: 1.000,00)
    • valorTotalDe (query, string) — Valor total de (Formato: 1.000,00)
    • valorTotalAte (query, string) — Valor total até (Formato: 1.000,00)
  • Retorna: array<ConvenioDTO>

GET /api-de-dados/convenios/tipo-instrumento

Consulta os tipos de instrumentos usados nos convênios

  • Retorna: array<TipoInstrumentoDTO>

GET /api-de-dados/convenios/numero

Consulta um convênio do Poder Executivo Federal pelo número do contrato

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Número;
  • Obrigatórios:
    • numero (query, string) — Número do convênio
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ConvenioDTO>

GET /api-de-dados/convenios/numero-processo

Consulta um convênio do Poder Executivo Federal pelo número do processo

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Número do processo;
  • Obrigatórios:
    • numeroProcesso (query, string) — Número do processo
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ConvenioDTO>

GET /api-de-dados/convenios/numero-original

Consulta um convênio do Poder Executivo Federal pelo número original do contrato

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Número;
  • Obrigatórios:
    • numeroOriginal (query, string) — Número original do convênio
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ConvenioDTO>

GET /api-de-dados/convenios/id

Consulta um convênio do Poder Executivo Federal pelo id

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (query, integer) — ID do registro
  • Retorna: ConvenioDTO

Contratos do Poder Executivo Federal

GET /api-de-dados/contratos

Consulta os todos contratos do Poder Executivo Federal

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Código do Órgão (SIAFI); Data vigência início; Data vigência fim
  • Obrigatórios:
  • Opcionais:
    • dataInicial (query, string) — Data vigência início (DD/MM/AAAA)
    • dataFinal (query, string) — Data vigência fim (DD/MM/AAAA)
  • Retorna: array<ContratoDTO>

GET /api-de-dados/contratos/termo-aditivo

Consulta os termos aditivos do contrato pelo id do contrato

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (query, integer) — ID do registro
  • Retorna: array<TermoAditivoDTO>

GET /api-de-dados/contratos/processo

Consulta um contrato do Poder Executivo Federal pelo número do processo

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Processo;
  • Obrigatórios:
    • processo (query, string) — Número do processo
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ContratoDTO>

GET /api-de-dados/contratos/numero

Consulta um contrato do Poder Executivo Federal pelo número do contrato

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Número;
  • Obrigatórios:
    • numero (query, string) — Número do contrato
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ContratoDTO>

GET /api-de-dados/contratos/itens-contratados

Consulta os itens contratados pelo id do contrato

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (query, integer) — ID do registro
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ItemContratadoDTO>

GET /api-de-dados/contratos/id

Consulta um contrato do Poder Executivo Federal pelo id

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (query, integer) — ID do registro
  • Retorna: ContratoDTO

GET /api-de-dados/contratos/documentos-relacionados

Consulta os documentos relacionados a um contrato pelo id do contrato

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (query, integer) — ID do registro
  • Retorna: array<EmpenhoComprasDTO>

GET /api-de-dados/contratos/cpf-cnpj

Consulta um contrato do Poder Executivo Federal pelo CPF/CNPJ do Fornecedor

  • Filtros/regras: Filtros mínimos: CPF/CNPJ do Fornecedor
  • Obrigatórios:
    • cpfCnpj (query, string) — CPF/CNPJ do Fornecedor
    • pagina (query, integer (default=1)) — Página consultada
  • Retorna: array<ContratoDTO>

GET /api-de-dados/contratos/apostilamento

Consulta os apostilamentos do contrato pelo id do contrato

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (query, integer) — ID do registro
  • Retorna: array<ApostilamentoDTO>

Sanções

GET /api-de-dados/cnep

Consulta os registros do CNEP por CNPJ ou CPF Sancionado/Órgão Sancionador/Período

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • codigoSancionado (query, string) — CNPJ ou CPF do Sancionado
    • nomeSancionado (query, string) — Nome, nome fantasia ou razão social do Sancionado
    • orgaoSancionador (query, string) — Órgão Sancionador
    • dataInicialSancao (query, string) — Data Inicial da Sanção (DD/MM/AAAA)
    • dataFinalSancao (query, string) — Data Final da Sanção (DD/MM/AAAA)
  • Retorna: array<CnepDTO>

GET /api-de-dados/cnep/{id}

Consulta um registro do CNEP pelo id

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (path, integer) — ID do registro
  • Retorna: CnepDTO

GET /api-de-dados/cepim

Consulta os registros do CEPIM por CNPJ ou CPF Sancionado/Órgão superior

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • cnpjSancionado (query, string) — CNPJ do Sancionado
    • nomeSancionado (query, string) — Nome, nome fantasia ou razão social do Sancionado
    • ufSancionado (query, string) — UF do Sancionado (sigla)
    • orgaoEntidade (query, string) — Órgão/Entidade
  • Retorna: array<CepimDTO>

GET /api-de-dados/cepim/{id}

Consulta um registro do CEPIM pelo id

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (path, integer) — ID do registro
  • Retorna: CepimDTO

GET /api-de-dados/ceis

Consulta os registros do CEIS por CNPJ ou CPF Sancionado/Órgão Sancionador/Período

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • codigoSancionado (query, string) — CNPJ ou CPF Sancionado
    • nomeSancionado (query, string) — Nome, nome fantasia ou razão social do Sancionado
    • orgaoSancionador (query, string) — Órgão Sancionador
    • dataInicialSancao (query, string) — Data Inicial da Sanção (DD/MM/AAAA)
    • dataFinalSancao (query, string) — Data Final da Sanção (DD/MM/AAAA)
  • Retorna: array<CeisDTO>

GET /api-de-dados/ceis/{id}

Consulta um registro do CEIS pelo id

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (path, integer) — ID do registro
  • Retorna: CeisDTO

GET /api-de-dados/ceaf

Consulta os registros do CEAF por CPF/Órgão de Lotação/Período

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • cpfSancionado (query, string) — CPF do sancionado
    • nomeSancionado (query, string) — Nome do sancionado
    • orgaoLotacao (query, string) — Órgão de lotação
    • dataPublicacaoInicio (query, string) — Data publicação início (DD/MM/AAAA)
    • dataPublicacaoFim (query, string) — Data publicação fim (DD/MM/AAAA)
  • Retorna: array<CeafDTO>

GET /api-de-dados/ceaf/{id}

Consulta um registro do CEAF pelo id

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (path, integer) — ID do registro
  • Retorna: CeafDTO

GET /api-de-dados/acordos-leniencia

Consulta os registros de Acordos de Leniência por Nome ou CNPJ do Sancionado/Situação/Período

  • Filtros/regras: Filtros mínimos: Página (padrão = 1);
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • cnpjSancionado (query, string) — CNPJ sancionado
    • nomeSancionado (query, string) — Nome, nome fantasia ou razão social do sancionado
    • situacao (query, string) — Situação do acordo
    • dataInicialSancao (query, string) — Data inicial da sanção (DD/MM/AAAA)
    • dataFinalSancao (query, string) — Data final da sanção (DD/MM/AAAA)
  • Retorna: array<AcordosLenienciaDTO>

GET /api-de-dados/acordos-leniencia/{id}

Consulta um registro de Acordo de Leniência pelo id

  • Filtros/regras: Filtros mínimos: ID do registro
  • Obrigatórios:
    • id (path, integer) — ID do registro
  • Retorna: AcordosLenienciaDTO

Gastos por meio de cartão de pagamento

GET /api-de-dados/cartoes

Consulta os registros de Cartões de Pagamento

  • Filtros/regras: Filtros mínimos: Página (padrão = 1); Período de até 12 meses ou um órgão ou um portador ou um favorecido específico;
  • Obrigatórios:
    • pagina (query, integer (default=1)) — Página consultada
  • Opcionais:
    • mesExtratoInicio (query, string) — Mês extrato início (MM/AAAA)
    • mesExtratoFim (query, string) — Mês extrato fim (MM/AAAA)
    • dataTransacaoInicio (query, string) — Data transação início (DD/MM/AAAA)
    • dataTransacaoFim (query, string) — Data transação fim (DD/MM/AAAA)
    • tipoCartao (query, integer) — Tipo de cartão (CPGF=1 ou CPCC=2 ou CPDC=3)
    • codigoOrgao (query, string) — Órgão/Entidade (Código SIAFI)
    • cpfPortador (query, string) — Portador (CPF)
    • cpfCnpjFavorecido (query, string) — Favorecido (CPF/CNPJ)
    • valorDe (query, string) — Valor de (####,##)
    • valorAte (query, string) — Valor até (####,##)
  • Retorna: array<CartoesDTO>