1. Home
  2. DADOS ABERTOS
  3. Definições da API

Definições da API DADOS ABERTOS

04/04/2024

O acesso aos dados abertos de Dotações é feito através de nossa API, que consiste em endereços na Internet (URL) prontos para serem aproveitados por outros aplicativos. É possível realizar consultas através da passagem de parâmetros, com os dados sendo disponibilizados nos formatos XML, JSON e CSV.
 

URL Básica
Para acessar os dados é preciso conhecer a URL básica e o formato dos parâmetros.

URL:

 https://portal.tcm.sp.gov.br/api/iris/dotacoes/{anoReferencia}/{formato}

Onde:

  • {anoReferencia} - ano das informações que serão consultadas (valor obrigatório)
  • {formato} - formato do resultado que será apresentado (valor obrigatório)

 

Atenção:

  • Somente os dados de entrada podem ser usados para fazer consultas;
  • Verifique a documentação de cada método para saber se existem parâmetros obrigatórios.

Exemplo

Exemplos de consultas utilizando a API de Dados Abertos:

Exemplo 1: Para listar os dados abertos de 2023 no formato XML, utilize a seguinte url: https://portal.tcm.sp.gov.br/api/iris/dotacoes/2023/xml

Exemplo 2: Para listar os dados abertos de 2024 no formato CSV, utilize a seguinte url: https://portal.tcm.sp.gov.br/api/iris/dotacoes/2024/csv, e o arquivo ficará disponível para download.


Voltar