API / Consulta Avançada de Receitas

Consulta Avançada

Esta consulta é totalmente aberta para a customização de campos e filtros a serem utilizados. A partir dela, podem ser montadas diversas consultas cruzando informações de Receitas e especificando as colunas que devem ser exibidas. O retorno depende dos parâmetros que serão utilizados.

 

URL

/receita/json-receita-avancada-filtro/

 

MÉTODO

GET

 

PARÂMETROS

Obrigatórios

Nome Tipo Descrição Valores
limit integer Seta um limite de resultados apresentados na consulta. 1 a 1000
offset integer Seta a quantidade de valores que será ignorada no início dos resultados. Apresentada o próximo valor após o offset. -
data_registro_dti_ Date Seta a data inicial que será realizada a consulta. (dd/mm/yyyy) -
data_registro_dtf_ Date Seta a data final que será realizada a consulta. (dd/mm/yyyy) -
visualizar text Define quais colunas serão exibidas. Pode ser vários. ex: visualizar=descricao_ug&visualizar=ano descricao_ug, ug, descricao_natureza2, descricao_natureza3, descricao_natureza4, descricao_natureza5, descricao_natureza6, descricao_natureza, descricao_fonte_mae, descricao_fonte, ano, mes
valor text Define quais valores serão exibidos. Pode ser vários. ex: valor=inicial&valor=realizado inicial, realizado

 

Opcionais

Nome Tipo Descrição
ug__in text Filtra pelo código da unidade gestora entre as retornadas na consulta.
descricao_ug__in text Filtra pelo nome da unidade gestora entre as retornadas na consulta.
descricao_natureza2__in (cat. econômica) text Filtra pelo nome da categoria econômica entre as retornadas na consulta.
descricao_natureza3__in (origem) text Filtra pelo nome da origem entre as retornadas na consulta.
descricao_natureza4__in (espécie) text Filtra pelo nome da espécie entre as retornadas na consulta.
descricao_natureza5__in (rubrica) text Filtra pelo nome da rubrica entre as retornadas na consulta.
descricao_natureza6__in (alínea) text Filtra pelo nome do alínea entre as retornadas na consulta.
descricao_natureza__in (subalínea) text Filtra pelo nome do subalínea entre as retornadas na consulta.
descricao_fonte_mae__in text Filtra pelo nome da fonte mãe entre as retornadas na consulta.
descricao_fonte__in text Filtra pelo nome da fonte entre as retornadas na consulta.
sort text Define o campo o qual será ordenada a consulta.
order text Define a ordem que será ordenada a consulta. Valores: asc / desc

* Os parâmetros com __in no final podem ter mais de um valor associado. Exemplo: /?ug__in=64647&ug__in=92782

 

EXEMPLO

URL utilizada: http://transparencia.al.gov.br/receita/json-receita-avancada-filtro/?data_registro_dti_=01/01/2013&data_registro_dtf_=31/12/2015&visualizar=ano&limit=3&offset=0&valor=inicial&valor=realizado

 

{
  "total": 3,
  "detalhe": {
    "valor_atualizado_inicial__sum": "8.474.307.073,64",
    "ano": 2013,
    "valor_atualizado_inicial_total": "25.525.318.182,13",
    "valor_atualizado_realizado_total": "22.170.585.200,28",
    "valor_atualizado_realizado__sum": "7.387.284.180,80"
  },
  "rows": [
    {
      "ano": 2013,
      "valor_realizado": "7.387.284.180,80",
      "valor_inicial": "8.474.307.073,64"
    },
    {
      "ano": 2014,
      "valor_realizado": "7.850.209.799,24",
      "valor_inicial": "8.706.953.677,08"
    },
    {
      "ano": 2015,
      "valor_realizado": "6.933.091.220,24",
      "valor_inicial": "8.344.057.431,41"
    }
  ]
}

TENHA ACESSO ÀS INFORMAÇÕES ATRAVÉS DE DADOS ABERTOS
2007-2024. Conteúdo e dados do Portal da Transparência licenciados sob Licença Creative Commons Licença Creative Commons BY-SA Open Data