{ "swagger": "2.0", "info": { "title": "API do dadosjusbr.org", "contact": { "name": "DadosJusBr", "url": "https://dadosjusbr.org" }, "version": "1.0" }, "paths": { "/uiapi/v1/orgao/resumo/{orgao}": { "get": { "description": "Retorna os dados de remuneração de todos os anos disponíveis para um órgão específico, incluindo:\n- Remuneração base/salário, outras remunerações/benefícios, descontos e remuneração líquida (salário+benefícios-descontos). Dados brutos, agrupados por mês e per capita\n- Quantidade de meses com dados no determinado ano\n- Quantidade média de membros do órgão naquele ano\n- Resumo dos benefícios identificados (rubricas/penduricalhos) e seus respectivos valores no ano\n- Informações do pacote de dados, URL do pacote de dados para download, seu hash e tamanho do pacote de dados (em bytes)", "produces": [ "application/json" ], "tags": [ "ui_api" ], "operationId": "GetAnnualSummary", "parameters": [ { "type": "string", "description": "Nome do orgão", "name": "orgao", "in": "path", "required": true } ], "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "type": "array", "items": { "$ref": "#/definitions/uiapi.annualSummary" } } }, "400": { "description": "Parâmetro orgao inválido", "schema": { "type": "string" } }, "500": { "description": "Algo deu errado ao tentar coletar os dados anuais do orgao", "schema": { "type": "string" } } } } }, "/uiapi/v2/download": { "get": { "description": "Baixa um arquivo csv referentes a remunerações a partir de filtros. O arquivo tem um limite de 10 mil linhas. Para cada parâmetro, é possível passar múltiplos valores separados por vírgula. As colunas do arquivo csv são:\n\n- Nome do órgão\n- Mês de referência do contracheque\n- Ano de referência do contracheque\n- Matrícula do membro (identificador único do membro no órgão)\n- Nome do membro\n- Cargo que o membro exerce no órgão\n- Lotação (unidade na qual o membro do órgão desenvolve suas atividades)\n- Categoria do contracheque (base, outras remunerações ou descontos)\n- Detalhamento do contracheque (ex: subsídio, desconto, benefício, etc)\n- Valor do contracheque em reais, não corrigido pela inflação", "produces": [ "application/json" ], "tags": [ "ui_api" ], "operationId": "DownloadByUrl", "parameters": [ { "type": "string", "description": "Anos a serem pesquisados, separados por virgula. Exemplo: 2018,2019,2020", "name": "anos", "in": "query" }, { "type": "string", "description": "Meses a serem pesquisados, separados por virgula. Exemplo: 1,2,3", "name": "meses", "in": "query" }, { "type": "string", "description": "Orgãos a serem pesquisados, separados por virgula. Exemplo: tjal,mpal,mppb", "name": "orgaos", "in": "query" }, { "enum": [ "base", "outras", "descontos" ], "type": "string", "description": "Categorias a serem pesquisadas. Se nada for informado, todas as categorias serão baixadas", "name": "categorias", "in": "query" } ], "responses": { "200": { "description": "Arquivo CSV com os dados.", "schema": { "type": "file" } }, "400": { "description": "Erro de validação dos parâmetros.", "schema": { "type": "string" } }, "500": { "description": "Erro interno do servidor.", "schema": { "type": "string" } } } } }, "/uiapi/v2/geral/remuneracao/{ano}": { "get": { "description": "Busca os dados, das remunerações (remuneração base/salário, outras remunerações/benefícios, descontos) e benefícios identificados (rubricas/penduricalhos) de um ano inteiro, agrupados por mês.", "produces": [ "application/json" ], "tags": [ "ui_api" ], "operationId": "GetGeneralRemunerationFromYear", "parameters": [ { "type": "string", "description": "Ano da remuneração. Ex.: 2018, 2019, 2020...", "name": "ano", "in": "path", "required": true } ], "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "type": "array", "items": { "$ref": "#/definitions/uiapi.mensalRemuneration" } } }, "400": { "description": "Parâmetro ano inválido.", "schema": { "type": "string" } }, "500": { "description": "Erro interno.", "schema": { "type": "string" } } } } }, "/uiapi/v2/geral/resumo": { "get": { "description": "Busca e resume os dados das remunerações de todos os anos, trazendo o número de órgão participantes das tetativas de coleta (inclue os órgãos da coleta automatizada, coleta manual e órgãos não coletados, mas que armazenamos alguma informação), número total de meses coletados, data do primeiro e último mês coletado e o valor total de remuneração considerando todos os meses.", "produces": [ "application/json" ], "tags": [ "ui_api" ], "operationId": "GetGeneralSummary", "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "$ref": "#/definitions/uiapi.generalSummary" } }, "500": { "description": "Erro interno do servidor.", "schema": { "type": "string" } } } } }, "/uiapi/v2/orgao/media/{ano}": { "get": { "description": "Busca médias (remuneração base, outras remunerações, descontos e remuneração total) de cada órgão em um ano especificado.", "produces": [ "application/json" ], "tags": [ "ui_api" ], "operationId": "GetAveragePerAgency", "parameters": [ { "type": "integer", "description": "Ano para filtrar os dados", "name": "ano", "in": "path", "required": true } ], "responses": { "200": { "description": "Lista de dados de médias dos órgãos", "schema": { "type": "array", "items": { "$ref": "#/definitions/uiapi.averagePerAgency" } } }, "400": { "description": "Parâmetro ANO inválido", "schema": { "type": "string" } }, "500": { "description": "Erro ao buscar dados", "schema": { "type": "string" } } } } }, "/uiapi/v2/orgao/resumo/{orgao}/{ano}/{mes}": { "get": { "description": "Endpoint de resumo das remunerações mensal de um órgão. Fornece uma análise financeira abrangente para um órgão específico em um mês e ano determinados\n\nInformações Financeiras Detalhadas:\n- Remuneração base total e máxima\n- Outras remunerações e benefícios\n- Valor total de descontos\n- Contagem de membros\n- Análise de rubricas (penduricalhos) específicas\n\nContexto Adicional:\n- Marcadores de existência de dados anteriores/posteriores ao ano/mês consultados\n- Timestamp da coleta de dados\n- Detalhamento de diferentes tipos de remuneração (remuneração base, outras remunerações e descontos)", "produces": [ "application/json" ], "tags": [ "ui_api" ], "operationId": "GetSummaryOfAgency", "parameters": [ { "type": "string", "description": "Sigla do órgão. Ex.: tjal, mppb, tjmmg", "name": "orgao", "in": "path", "required": true }, { "type": "string", "description": "Mês de referência (1-12)", "name": "mes", "in": "path", "required": true }, { "type": "string", "description": "Ano de referência", "name": "ano", "in": "path", "required": true } ], "responses": { "200": { "description": "Resumo financeiro do órgão processado com sucesso", "schema": { "$ref": "#/definitions/uiapi.v2AgencySummary" } }, "400": { "description": "Erro de validação dos parâmetros de entrada", "schema": { "type": "string" } }, "404": { "description": "Órgão ou dados não encontrados", "schema": { "type": "string" } }, "500": { "description": "Erro interno durante processamento da consulta", "schema": { "type": "string" } } } } }, "/uiapi/v2/orgao/salario/{orgao}/{ano}/{mes}": { "get": { "description": "Endpoint de análise detalhada de remunerações dos órgãos. Recupera informações financeiras granulares para um órgão específico em um mês e ano determinados\n\nInformações Fornecidos:\n- Remuneração máxima no período\n- Histograma de distribuição de rendimentos\n- Metadados do pacote de dados\n\nHistograma de Distribuição de Rendimentos:\n\nO histograma apresenta a quantidade de membros que receberam diferentes faixas de remunerações em um determinado mês.\nAs faixas de remuneração são definidas da seguinte forma:\n- 10000: quantidade de membros que receberam até R$ 10.000,00\n- 20000: quantidade de membros que receberam entre R$ 10.000,01 e R$ 20.000,00\n- 30000: quantidade de membros que receberam entre R$ 20.000,01 e R$ 30.000,00\n- 40000: quantidade de membros que receberam entre R$ 30.000,01 e R$ 40.000,00\n- 50000: quantidade de membros que receberam entre R$ 40.000,01 e R$ 50.000,00\n- -1: quantidade de membros que receberam acima de R$ 50.000,01", "produces": [ "application/json" ], "tags": [ "ui_api" ], "operationId": "GetSalaryOfAgencyMonthYear", "parameters": [ { "type": "string", "description": "Sigla do órgão. Ex.: tjal, mppb, tjmmg", "name": "orgao", "in": "path", "required": true }, { "type": "string", "description": "Mês de referência (1-12)", "name": "mes", "in": "path", "required": true }, { "type": "string", "description": "Ano de referência", "name": "ano", "in": "path", "required": true } ], "responses": { "200": { "description": "Dados de remuneração processados com sucesso", "schema": { "$ref": "#/definitions/uiapi.agencyRemuneration" } }, "206": { "description": "Dados coletados com informações de processamento", "schema": { "$ref": "#/definitions/uiapi.v2ProcInfoResult" } }, "400": { "description": "Erro de validação dos parâmetros de entrada", "schema": { "type": "string" } }, "500": { "description": "Erro interno durante processamento da consulta", "schema": { "type": "string" } } } } }, "/uiapi/v2/orgao/totais/{orgao}/{ano}": { "get": { "description": "Recupera dados financeiros detalhados para um órgão em um ano específico\n\nDados Financeiros Mensais:\n- Remuneração base\n- Outras remunerações e benefícios\n- Descontos\n- Contagem de membros\n\nMétricas Adicionais:\n- Médias per capita\n- Detalhamento de rubricas (auxílios, férias, gratificações)\n- Informações gerais sobre o órgão pesquisado\n- Informações sobre o pacote de dados (URL para download, hash, tamanho)", "produces": [ "application/json" ], "tags": [ "ui_api" ], "operationId": "GetTotalsOfAgencyYear", "parameters": [ { "type": "string", "description": "Identificador do órgão público", "name": "orgao", "in": "path", "required": true }, { "type": "integer", "description": "Ano de referência para a consulta", "name": "ano", "in": "path", "required": true } ], "responses": { "200": { "description": "Dados financeiros completos do órgão no ano especificado", "schema": { "$ref": "#/definitions/uiapi.v2AgencyTotalsYear" } }, "400": { "description": "Erro de validação: parâmetros de órgão ou ano inválidos", "schema": { "type": "string" } }, "500": { "description": "Erro interno durante processamento da consulta", "schema": { "type": "string" } } } } }, "/uiapi/v2/orgao/{grupo}": { "get": { "description": "Busca informações de id (sigla), nome e entidade (jurisdiçãso) de um determinado grupo de órgãos. Ao Selecionar um grupo de órgãos por estado (Ex.: RJ, SP, etc.), retorna as informações dos tribunais de justiça desse estado (entidade=Tribunal).", "produces": [ "application/json" ], "tags": [ "ui_api" ], "operationId": "GetBasicInfoOfType", "parameters": [ { "enum": [ "justica-eleitoral", "ministerios-publicos", "justica-estadual", "justica-do-trabalho", "justica-federal", "justica-militar", "justica-superior", "conselhos-de-justica", "AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO" ], "type": "string", "description": "Grupo de órgãos", "name": "grupo", "in": "path" } ], "responses": { "200": { "description": "Órgãos do grupo", "schema": { "$ref": "#/definitions/uiapi.state" } }, "400": { "description": "Parâmetro inválido", "schema": { "type": "string" } }, "404": { "description": "Grupo não encontrado", "schema": { "type": "string" } } } } }, "/uiapi/v2/pesquisar": { "get": { "description": "Endpoint de busca avançada para remunerações de servidores públicos\n\nPermite realizar pesquisas detalhadas nas remunerações de servidores públicos com múltiplos filtros flexíveis:\n\n- Filtragem por anos específicos\n- Seleção de meses específicos\n- Pesquisa por órgãos públicos de diferentes esferas\n- Categorias de remuneração\n\nCaracterísticas principais:\n- Suporta múltiplas seleções em cada filtro\n- Permite combinações complexas de busca\n- Retorna dados consolidados de remuneração dos contracheques por membros\n\nCasos de uso:\n- Análise comparativa de remunerações entre diferentes órgãos\n- Análise análise granular das remunerações por membros dos órgãos", "produces": [ "application/json" ], "tags": [ "ui_api" ], "operationId": "SearchByUrl", "parameters": [ { "type": "string", "description": "Lista de anos a serem pesquisados, separados por virgula. Exemplo: 2018,2019,2020", "name": "anos", "in": "query" }, { "type": "string", "description": "Lista de meses a serem pesquisados, separados por virgula. Exemplo: 1,2,3", "name": "meses", "in": "query" }, { "type": "string", "description": "Lista de órgãos a serem pesquisados, separados por virgula. Exemplo: tjal,mpal,mppb", "name": "orgaos", "in": "query" }, { "enum": [ "base", "outras", "descontos" ], "type": "string", "description": "Categorias a serem pesquisadas. Remuneração base (salário), outras remunerações (benefícios) e descontos", "name": "categorias", "in": "query" } ], "responses": { "200": { "description": "Requisição bem-sucedida com dados de remuneração", "schema": { "$ref": "#/definitions/uiapi.searchResponse" } }, "400": { "description": "Erro de validação dos parâmetros de busca", "schema": { "type": "string" } }, "500": { "description": "Erro interno do servidor durante processamento da pesquisa", "schema": { "type": "string" } } } } }, "/uiapi/v2/readme": { "get": { "description": "Recupera o arquivo README com informações sobre o conjunto de dados. Permite filtrar o README com base em parâmetros opcionais de ano, mês e órgão\n\nComportamentos:\n- Se nenhum filtro for aplicado, retorna o README original\n- Com filtro de órgão, gera um README com observações específicas sobre potenciais falhas nos dados", "produces": [ "text/plain" ], "tags": [ "ui_api" ], "operationId": "DownloadReadme", "parameters": [ { "type": "string", "default": "2024", "description": "Ano para filtragem dos dados", "name": "ano", "in": "query" }, { "type": "string", "default": "12", "description": "Mês para filtragem dos dados", "name": "mes", "in": "query" }, { "type": "string", "default": "tjrr", "description": "Sigla do órgão para filtragem. Ex.: tjal, mppb, mpdft", "name": "orgao", "in": "query" } ], "responses": { "200": { "description": "README.txt com conteúdo detalhado", "schema": { "type": "string" } }, "400": { "description": "Erro de validação de parâmetros (ano/mês inválidos)", "schema": { "type": "string" } }, "500": { "description": "Erro interno ao processar o README", "schema": { "type": "string" } } } } }, "/v2/dados/{orgao}": { "get": { "description": "Busca todos os dados de um órgão específico trazendo informações de cada mês disponível para cada ano disponível a partir de 2018, retornando status de coleta, dados de coleta (duração da coleta e dados do coletor), dados sumarizados de remuneração (dos membros ativos, remuneração base/salário, outras remunerações/benefícios, descontos, remunerações líquidas, quantidade de membros, e gasto em rubricas identificadas/penduricalhos), metadados de completude e facilidade de acesso e pontuações referentes ao índice de transparência nas dimensões de completude, facilidade de acesso e transparência (https://dadosjusbr.org/indice).", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetAllAgencyInformation", "parameters": [ { "type": "string", "description": "Sigla do órgão para o qual os dados estão sendo solicitados. Ex.: tjal, tjba, mppb", "name": "orgao", "in": "path", "required": true } ], "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "$ref": "#/definitions/papi.allAgencyInformation" } }, "400": { "description": "Requisição inválida.", "schema": { "type": "string" } } } } }, "/v2/dados/{orgao}/{ano}": { "get": { "description": "Busca os dados mensais de um órgão específico trazendo informações de cada mês disponível para o ano informado, retornando status de coleta, dados de coleta (duração da coleta e dados do coletor), dados sumarizados de remuneração (dos membros ativos, remuneração base/salário, outras remunerações/benefícios, descontos, remunerações líquidas, quantidade de membros, e gasto em rubricas identificadas/penduricalhos), metadados de completude e facilidade de acesso e pontuações referentes ao índice de transparência nas dimensões de completude, facilidade de acesso e transparência (https://dadosjusbr.org/indice).", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetMonthlyInfosByYear", "parameters": [ { "type": "integer", "description": "Ano para o qual os dados estão sendo solicitados (dados disponíveis a partir de 2018).", "name": "ano", "in": "path", "required": true }, { "type": "string", "description": "Sigla do órgão para o qual os dados estão sendo solicitados. Ex.: tjal, tjba, mppb", "name": "orgao", "in": "path", "required": true } ], "responses": { "200": { "description": "Requisição bem-sucedida com dados mensais", "schema": { "type": "array", "items": { "$ref": "#/definitions/papi.summaryzedMI" } } }, "400": { "description": "Parâmetros inválidos", "schema": { "type": "string" } }, "404": { "description": "Não existem dados para os parâmetros informados", "schema": { "type": "string" } } } } }, "/v2/dados/{orgao}/{ano}/{mes}": { "get": { "description": "Busca informações mensais de um órgão específico, incluindo dados de coleta (status e duração da coleta e dados do coletor), dados de remuneração sumarizados (dos membros ativos, remuneração base/salário, outras remunerações/benefícios, descontos, remunerações líquidas, quantidade de membros, e gasto em rubricas identificadas/penduricalhos), metadados de completude e facilidade de acesso e pontuações referentes ao índice de transparência nas dimensões de completude, facilidade de acesso e transparência (https://dadosjusbr.org/indice).", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetMonthlyInfo", "parameters": [ { "type": "integer", "description": "Ano para o qual os dados estão sendo solicitados (dados disponíveis a partir de 2018).", "name": "ano", "in": "path", "required": true }, { "type": "string", "description": "Sigla do órgão para o qual os dados estão sendo solicitados. Ex.: tjal, tjba, mppb", "name": "orgao", "in": "path", "required": true }, { "type": "integer", "description": "Mês para o qual os dados estão sendo solicitados (1-12).", "name": "mes", "in": "path", "required": true } ], "responses": { "200": { "description": "Requisição bem-sucedida com dados mensais", "schema": { "$ref": "#/definitions/papi.summaryzedMI" } }, "400": { "description": "Parâmetros inválidos", "schema": { "type": "string" } }, "404": { "description": "Não existem dados para os parâmetros informados", "schema": { "type": "string" } } } } }, "/v2/indice": { "get": { "description": "Busca informações do Índice de Transparência (https://dadosjusbr.org/indice) de todos os órgãos, trazendo o detalhamento (granularidade mensal), os metadados (critérios de avaliação do Índice de Transparência) e o objeto agregado do detalhamento (compilado do Índice de Trasparência médio do órgão ao longo dos meses) organizando-os por jurisdição: Justiça Estadual, Ministérios Públicos, Justiça do Trabalho, Justiça Militar, Justiça Federal, Justiça Eleitoral, Justiça Superior e Conselhos de Justiça.", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetAggregateIndexes", "parameters": [ { "type": "boolean", "description": "Alterna entre o Índice de Transparência geral de todos os órgãos (true) ou o detalhamento do índice de cada órgão mês a mês.", "name": "agregado", "in": "query" }, { "type": "boolean", "description": "Define se os metadados utilizados para calcular o índice serão retornados ou não.", "name": "detalhe", "in": "query" } ], "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexesByGroup" } } }, "500": { "description": "Erro interno do servidor.", "schema": { "type": "string" } } } } }, "/v2/indice/{param}/{valor}": { "get": { "description": "Busca informações do Índice de Transparência (https://dadosjusbr.org/indice) do órgão (param=orgao) ou da jurisdição (param=grupo) informada, trazendo o detalhamento (granularidade mensal), os metadados (critérios de avaliação do índice) e o objeto agregado do detalhamento (compilado do Índice de Trasparência médio do órgão ao longo dos meses). As jurisdições possíveis são: justica-estadual, ministerios-publicos, justica-do-trabalho, justica-militar, justica-federal, justica-eleitoral, justica-superior e conselhos-de-justica.", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetAggregateIndexesWithParams", "parameters": [ { "type": "string", "description": "'grupo' para pesquisar por jurisdição ou 'orgao' para pesquisar pela sigla do órgão", "name": "param", "in": "path", "required": true }, { "type": "string", "description": "Jurisdição ou sigla do órgao. Ex.: tjal, mpdft, justica-estadual, etc.", "name": "valor", "in": "path", "required": true }, { "type": "boolean", "description": "Alterna entre o Índice de Transparência geral de todos os órgãos (true) ou o detalhamento do índice de cada órgão mês a mês.", "name": "agregado", "in": "query" }, { "type": "boolean", "description": "Define se os metadados utilizados para calcular o índice serão retornados ou não.", "name": "detalhe", "in": "query" } ], "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } } }, "400": { "description": "Requisição inválida.", "schema": { "type": "string" } }, "500": { "description": "Erro interno do servidor.", "schema": { "type": "string" } } } } }, "/v2/indice/{param}/{valor}/{ano}": { "get": { "description": "Busca informações do Índice de Transparência (https://dadosjusbr.org/indice) do órgão (param=orgao) ou da jurisdição (param=grupo) informada, trazendo o detalhamento (granularidade mensal), os metadados (critérios de avaliação do índice) e o objeto agregado do detalhamento (compilado do Índice de Trasparência médio do órgão ao longo dos meses). As jurisdições possíveis são: justica-estadual, ministerios-publicos, justica-do-trabalho, justica-militar, justica-federal, justica-eleitoral, justica-superior e conselhos-de-justica.", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetAggregateIndexesWithParamsByYear", "parameters": [ { "type": "string", "description": "'grupo' para pesquisar por jurisdição ou 'orgao' para pesquisar pela sigla do órgão", "name": "param", "in": "path", "required": true }, { "type": "string", "description": "Jurisdição ou sigla do órgao. Ex.: tjal, mpdft, justica-estadual, etc.", "name": "valor", "in": "path", "required": true }, { "type": "integer", "description": "Ano para o qual os dados estão sendo solicitados (dados disponíveis a partir de 2018).", "name": "ano", "in": "path", "required": true }, { "type": "boolean", "description": "Alterna entre o Índice de Transparência geral de todos os órgãos (true) ou o detalhamento do índice de cada órgão mês a mês.", "name": "agregado", "in": "query" }, { "type": "boolean", "description": "Define se os metadados utilizados para calcular o índice serão retornados ou não.", "name": "detalhe", "in": "query" } ], "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } } }, "400": { "description": "Requisição inválida.", "schema": { "type": "string" } }, "500": { "description": "Erro interno do servidor.", "schema": { "type": "string" } } } } }, "/v2/indice/{param}/{valor}/{ano}/{mes}": { "get": { "description": "Busca informações do Índice de Transparência (https://dadosjusbr.org/indice) do órgão (param=orgao) ou da jurisdição (param=grupo) informada, trazendo o detalhamento (granularidade mensal), os metadados (critérios de avaliação do índice) e o objeto agregado do detalhamento (compilado do Índice de Trasparência médio do órgão ao longo dos meses). As jurisdições possíveis são: justica-estadual, ministerios-publicos, justica-do-trabalho, justica-militar, justica-federal, justica-eleitoral, justica-superior e conselhos-de-justica.", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetAggregateIndexesWithParamsByYearAndMonth", "parameters": [ { "type": "string", "description": "'grupo' para pesquisar por jurisdição ou 'orgao' para pesquisar pela sigla do órgão", "name": "param", "in": "path", "required": true }, { "type": "string", "description": "Jurisdição ou sigla do órgao. Ex.: tjal, mpdft, justica-estadual, etc.", "name": "valor", "in": "path", "required": true }, { "type": "integer", "description": "Ano para o qual os dados estão sendo solicitados (dados disponíveis a partir de 2018).", "name": "ano", "in": "path", "required": true }, { "type": "integer", "description": "Mês para o qual os dados estão sendo solicitados (1-12).", "name": "mes", "in": "path", "required": true }, { "type": "boolean", "description": "Alterna entre o Índice de Transparência geral de todos os órgãos (true) ou o detalhamento do índice de cada órgão mês a mês.", "name": "agregado", "in": "query" }, { "type": "boolean", "description": "Define se os metadados utilizados para calcular o índice serão retornados ou não.", "name": "detalhe", "in": "query" } ], "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } } }, "400": { "description": "Requisição inválida.", "schema": { "type": "string" } }, "500": { "description": "Erro interno do servidor.", "schema": { "type": "string" } } } } }, "/v2/orgao/{orgao}": { "get": { "description": "Busca informações gerais de um órgão como nome completo, jurisdição, tipo de entidade, uf do órgão, perfil do twitter e link para a ouvidoria. Se o órgão informado não for coletado pelo DadosJusBr, um objeto com o motivo da coleta não ser automatizada também será retornado. Não inclue informações de remuneração.", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetAgencyById", "parameters": [ { "type": "string", "description": "Sigla do órgão para o qual os dados estão sendo solicitados. Ex.: tjal, tjba, mppb.", "name": "orgao", "in": "path", "required": true } ], "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "$ref": "#/definitions/papi.agency" } }, "404": { "description": "Órgão não encontrado.", "schema": { "type": "string" } } } } }, "/v2/orgaos": { "get": { "description": "Busca informações gerais de todos os órgão como nome completo, jurisdição, tipo de entidade, uf do órgão, perfil do twitter e link para a ouvidoria. Se algum órgão da lista não for coletado pelo DadosJusBr, um objeto com o motivo da coleta não ser automatizada também será retornado. Não inclue informações de remuneração.", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetAllAgencies", "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "type": "array", "items": { "$ref": "#/definitions/papi.agency" } } }, "500": { "description": "Erro interno do servidor.", "schema": { "type": "string" } } } } }, "/v2/retroativos/{orgao}/{ano}": { "get": { "description": "Busca todos os dados de verbas referentes a exercícios anteriores de um órgão para um ano específico, retornando uma lista detalhada de pagamentos (valores, descontos, tributos, identificação do membro, lotação e dados processuais).", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetRetroactivePayments", "parameters": [ { "type": "string", "description": "Sigla do ministério público para o qual os dados estão sendo solicitados. Ex.: tjal, tjba, mppb", "name": "orgao", "in": "path", "required": true }, { "type": "integer", "description": "Ano para o qual os dados estão sendo solicitados (dados disponíveis a partir de 2023).", "name": "ano", "in": "path", "required": true } ], "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "$ref": "#/definitions/papi.retroactivePayment" } }, "400": { "description": "Requisição inválida.", "schema": { "type": "string" } } } } }, "/v2/retroativos/{orgao}/{ano}/{mes}": { "get": { "description": "Busca todos os dados de verbas referentes a exercícios anteriores de um órgão para um ano e mês específicos, retornando uma lista detalhada de pagamentos (valores, descontos, tributos, identificação do membro, lotação e dados processuais).", "produces": [ "application/json" ], "tags": [ "public_api" ], "operationId": "GetRetroactivePaymentsByYearAndMonth", "parameters": [ { "type": "string", "description": "Sigla do ministério público para o qual os dados estão sendo solicitados. Ex.: tjal, tjba, mppb", "name": "orgao", "in": "path", "required": true }, { "type": "integer", "description": "Ano para o qual os dados estão sendo solicitados (dados disponíveis a partir de 2023).", "name": "ano", "in": "path", "required": true }, { "type": "integer", "description": "Mês para o qual os dados estão sendo solicitados.", "name": "mes", "in": "path", "required": true } ], "responses": { "200": { "description": "Requisição bem sucedida.", "schema": { "$ref": "#/definitions/papi.retroactivePayment" } }, "400": { "description": "Requisição inválida.", "schema": { "type": "string" } } } } } }, "definitions": { "papi.agency": { "type": "object", "properties": { "coletando": { "type": "array", "items": { "$ref": "#/definitions/papi.collecting" } }, "entidade": { "description": "\"J\" For Judiciário, \"M\" for Ministério Público, \"P\" for Procuradorias and \"D\" for Defensorias.", "type": "string" }, "id_orgao": { "description": "'trt13'", "type": "string" }, "jurisdicao": { "description": "\"R\" for Regional, \"M\" for Municipal, \"F\" for Federal, \"E\" for State.", "type": "string" }, "nome": { "description": "'Tribunal Regional do Trabalho 13° Região'", "type": "string" }, "ouvidoria": { "description": "Agencys's ombudsman url", "type": "string" }, "possui_dados": { "description": "If there is data from that agency", "type": "boolean" }, "twitter_handle": { "description": "Agency's twitter handle", "type": "string" }, "uf": { "description": "Short code for federative unity.", "type": "string" }, "url": { "description": "Link for state url", "type": "string" } } }, "papi.aggregateIndexes": { "type": "object", "properties": { "agregado": { "description": "Aggregate indices", "allOf": [ { "$ref": "#/definitions/papi.score" } ] }, "detalhe": { "description": "All agency indices", "type": "array", "items": { "$ref": "#/definitions/papi.indexInformation" } }, "id_orgao": { "description": "e.g. 'trt13'", "type": "string" } } }, "papi.aggregateIndexesByGroup": { "type": "object", "properties": { "conselhos-de-justica": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } }, "justica-do-trabalho": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } }, "justica-eleitoral": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } }, "justica-estadual": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } }, "justica-federal": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } }, "justica-militar": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } }, "justica-superior": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } }, "ministerios-publicos": { "type": "array", "items": { "$ref": "#/definitions/papi.aggregateIndexes" } } } }, "papi.allAgencyInformation": { "type": "object", "properties": { "coletando": { "type": "array", "items": { "$ref": "#/definitions/papi.collecting" } }, "coletas": { "type": "array", "items": { "$ref": "#/definitions/papi.summaryzedMI" } }, "entidade": { "description": "\"J\" For Judiciário, \"M\" for Ministério Público, \"P\" for Procuradorias and \"D\" for Defensorias.", "type": "string" }, "id_orgao": { "description": "'trt13'", "type": "string" }, "indice_transparencia": { "$ref": "#/definitions/papi.score" }, "jurisdicao": { "description": "\"R\" for Regional, \"M\" for Municipal, \"F\" for Federal, \"E\" for State.", "type": "string" }, "meses_com_dados": { "type": "integer" }, "nome": { "description": "'Tribunal Regional do Trabalho 13° Região'", "type": "string" }, "ouvidoria": { "description": "Agencys's ombudsman url", "type": "string" }, "total_coletas_realizadas": { "type": "integer" }, "twitter_handle": { "description": "Agency's twitter handle", "type": "string" }, "uf": { "description": "Short code for federative unity.", "type": "string" }, "url": { "description": "Link for state url", "type": "string" } } }, "papi.backup": { "type": "object", "properties": { "hash": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" } } }, "papi.collect": { "type": "object", "properties": { "duracao_segundos": { "type": "number" }, "repositorio_coletor": { "type": "string" }, "repositorio_parser": { "type": "string" }, "versao_coletor": { "type": "string" }, "versao_parser": { "type": "string" } } }, "papi.collecting": { "type": "object", "properties": { "descricao": { "description": "Reasons why we didn't collect the data", "type": "array", "items": { "type": "string" } }, "timestamp": { "description": "Day(unix) we checked the status of the data", "type": "integer" } } }, "papi.dataSummary": { "type": "object", "properties": { "max": { "type": "number" }, "media": { "type": "number" }, "min": { "type": "number" }, "total": { "type": "number" } } }, "papi.indexInformation": { "type": "object", "properties": { "ano": { "type": "integer" }, "indice_transparencia": { "$ref": "#/definitions/papi.score" }, "mes": { "type": "integer" }, "metadados": { "$ref": "#/definitions/papi.metadata" } } }, "papi.itemSummary": { "type": "object", "additionalProperties": { "type": "number" } }, "papi.metadata": { "type": "object", "properties": { "acesso": { "type": "string" }, "dados_estritamente_tabulares": { "type": "boolean" }, "despesas": { "type": "string" }, "extensao": { "type": "string" }, "formato_aberto": { "type": "boolean" }, "manteve_consistencia_no_formato": { "type": "boolean" }, "outras_receitas": { "type": "string" }, "remuneracao_basica": { "type": "string" }, "tem_cargo": { "type": "boolean" }, "tem_lotacao": { "type": "boolean" }, "tem_matricula": { "type": "boolean" } } }, "papi.miError": { "type": "object", "properties": { "cmd": { "type": "string" }, "err_msg": { "type": "string" }, "status": { "type": "integer" } } }, "papi.retroactivePayment": { "type": "object", "properties": { "ano": { "type": "integer" }, "contribuicao_previdencial": { "type": "number" }, "deducao_teto_salarial": { "type": "number" }, "descontos": { "type": "number" }, "funcao": { "type": "string" }, "id_contracheque": { "description": "ID int `json:\"id,omitempty\"`", "type": "integer" }, "imposto_renda": { "type": "number" }, "local_trabalho": { "type": "string" }, "matricula": { "type": "string" }, "mes": { "type": "integer" }, "nome": { "type": "string" }, "numero_processo": { "type": "string" }, "objeto_processo": { "type": "string" }, "orgao": { "type": "string" }, "origem_processo": { "type": "string" }, "valor_bruto": { "type": "number" }, "valor_liquido": { "type": "number" } } }, "papi.score": { "type": "object", "properties": { "indice_completude": { "type": "number" }, "indice_facilidade": { "type": "number" }, "indice_transparencia": { "type": "number" } } }, "papi.summaries": { "type": "object", "properties": { "membros_ativos": { "$ref": "#/definitions/papi.summary" } } }, "papi.summary": { "type": "object", "properties": { "descontos": { "$ref": "#/definitions/papi.dataSummary" }, "outras_remuneracoes": { "$ref": "#/definitions/papi.dataSummary" }, "quantidade": { "type": "integer" }, "remuneracao_base": { "$ref": "#/definitions/papi.dataSummary" }, "remuneracoes": { "$ref": "#/definitions/papi.dataSummary" }, "resumo_rubricas": { "$ref": "#/definitions/papi.itemSummary" } } }, "papi.summaryzedMI": { "type": "object", "properties": { "ano": { "type": "integer" }, "coleta_manual": { "type": "boolean" }, "dados_coleta": { "$ref": "#/definitions/papi.collect" }, "error": { "$ref": "#/definitions/papi.miError" }, "id_orgao": { "type": "string" }, "inconsistente": { "type": "boolean" }, "indice_transparencia": { "$ref": "#/definitions/papi.score" }, "mes": { "type": "integer" }, "metadados": { "$ref": "#/definitions/papi.metadata" }, "pacote_de_dados": { "$ref": "#/definitions/papi.backup" }, "sumarios": { "$ref": "#/definitions/papi.summaries" } } }, "uiapi.agency": { "type": "object", "properties": { "coletando": { "type": "array", "items": { "$ref": "#/definitions/uiapi.collecting" } }, "entidade": { "description": "\"J\" For Judiciário, \"M\" for Ministério Público, \"P\" for Procuradorias and \"D\" for Defensorias.", "type": "string" }, "id_orgao": { "description": "'trt13'", "type": "string" }, "jurisdicao": { "description": "\"R\" for Regional, \"M\" for Municipal, \"F\" for Federal, \"E\" for State.", "type": "string" }, "nome": { "description": "'Tribunal Regional do Trabalho 13° Região'", "type": "string" }, "ouvidoria": { "description": "Agencys's ombudsman url", "type": "string" }, "possui_dados": { "description": "If there is data from that agency", "type": "boolean" }, "twitter_handle": { "description": "Agency's twitter handle", "type": "string" }, "uf": { "description": "Short code for federative unity.", "type": "string" }, "url": { "description": "Link for state url", "type": "string" } } }, "uiapi.agencyBasic": { "type": "object", "properties": { "agencyCategory": { "type": "string" }, "fullName": { "type": "string" }, "name": { "type": "string" } } }, "uiapi.agencyRemuneration": { "type": "object", "properties": { "histograma": { "type": "object", "additionalProperties": { "type": "integer" } }, "max_salario": { "type": "number" }, "package": { "$ref": "#/definitions/uiapi.backup" } } }, "uiapi.annualSummary": { "type": "object", "properties": { "dados_anuais": { "type": "array", "items": { "$ref": "#/definitions/uiapi.annualSummaryData" } }, "orgao": { "$ref": "#/definitions/uiapi.agency" } } }, "uiapi.annualSummaryData": { "type": "object", "properties": { "ano": { "type": "integer" }, "descontos": { "type": "number" }, "descontos_por_membro": { "type": "number" }, "descontos_por_mes": { "type": "number" }, "inconsistente": { "type": "boolean" }, "meses_com_dados": { "type": "integer" }, "num_membros": { "type": "integer" }, "outras_remuneracoes": { "type": "number" }, "outras_remuneracoes_por_membro": { "type": "number" }, "outras_remuneracoes_por_mes": { "type": "number" }, "package": { "$ref": "#/definitions/uiapi.backup" }, "remuneracao_base": { "type": "number" }, "remuneracao_base_por_membro": { "type": "number" }, "remuneracao_base_por_mes": { "type": "number" }, "remuneracoes": { "type": "number" }, "remuneracoes_por_membro": { "type": "number" }, "remuneracoes_por_mes": { "type": "number" }, "resumo_rubricas": { "$ref": "#/definitions/uiapi.itemSummary" } } }, "uiapi.averagePerAgency": { "type": "object", "properties": { "id_orgao": { "type": "string" }, "media_por_membro": { "$ref": "#/definitions/uiapi.perCapitaData" } } }, "uiapi.backup": { "type": "object", "properties": { "hash": { "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" } } }, "uiapi.collecting": { "type": "object", "properties": { "descricao": { "description": "Reasons why we didn't collect the data", "type": "array", "items": { "type": "string" } }, "timestamp": { "description": "Day(unix) we checked the status of the data", "type": "integer" } } }, "uiapi.generalSummary": { "type": "object", "properties": { "data_fim": { "type": "string" }, "data_inicio": { "type": "string" }, "num_contracheques": { "type": "integer" }, "num_meses_coletados": { "type": "integer" }, "num_orgaos": { "type": "integer" }, "remuneracao_total": { "type": "number" } } }, "uiapi.itemSummary": { "type": "object", "additionalProperties": { "type": "number" } }, "uiapi.mensalRemuneration": { "type": "object", "properties": { "descontos": { "type": "number" }, "mes": { "type": "integer" }, "num_membros": { "type": "integer" }, "outras_remuneracoes": { "type": "number" }, "remuneracao_base": { "type": "number" }, "remuneracoes": { "type": "number" }, "resumo_rubricas": { "$ref": "#/definitions/uiapi.itemSummary" } } }, "uiapi.perCapitaData": { "type": "object", "properties": { "descontos": { "type": "number" }, "outras_remuneracoes": { "type": "number" }, "remuneracao_base": { "type": "number" }, "remuneracoes": { "type": "number" } } }, "uiapi.procError": { "type": "object", "properties": { "stderr": { "description": "String containing the standard error of the process.", "type": "string" }, "stdout": { "description": "String containing the standard output of the process.", "type": "string" } } }, "uiapi.procInfo": { "type": "object", "properties": { "cmd": { "type": "string" }, "cmd_dir": { "type": "string" }, "env": { "type": "array", "items": { "type": "string" } }, "status": { "type": "integer" }, "stderr": { "type": "string" }, "stdin": { "type": "string" }, "stdout": { "type": "string" } } }, "uiapi.searchResponse": { "type": "object", "properties": { "download_available": { "type": "boolean" }, "download_limit": { "type": "integer" }, "num_rows_if_available": { "type": "integer" }, "result": { "type": "array", "items": { "$ref": "#/definitions/uiapi.searchResult" } }, "search_limit": { "type": "integer" } } }, "uiapi.searchResult": { "type": "object", "properties": { "ano": { "type": "integer" }, "cargo": { "type": "string" }, "categoria_contracheque": { "type": "string" }, "desambiguacao_macro": { "type": "string" }, "desambiguacao_micro": { "type": "string" }, "detalhamento_contracheque": { "type": "string" }, "lotacao": { "type": "string" }, "matricula": { "type": "string" }, "mes": { "type": "integer" }, "nome": { "type": "string" }, "orgao": { "type": "string" }, "valor": { "type": "string" } } }, "uiapi.state": { "type": "object", "properties": { "agency": { "type": "array", "items": { "$ref": "#/definitions/uiapi.agencyBasic" } }, "flagURL": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" } } }, "uiapi.timestamp": { "type": "object", "properties": { "nanos": { "type": "integer" }, "seconds": { "type": "integer" } } }, "uiapi.v2AgencySummary": { "type": "object", "properties": { "descontos": { "type": "number" }, "max_descontos": { "type": "number" }, "max_outras_remuneracoes": { "type": "number" }, "max_remuneracao": { "type": "number" }, "max_remuneracao_base": { "type": "number" }, "orgao": { "type": "string" }, "outras_remuneracoes": { "type": "number" }, "remuneracao_base": { "type": "number" }, "resumo_rubricas": { "$ref": "#/definitions/uiapi.itemSummary" }, "tem_anterior": { "type": "boolean" }, "tem_proximo": { "type": "boolean" }, "timestamp": { "$ref": "#/definitions/uiapi.timestamp" }, "total_membros": { "type": "integer" }, "total_remuneracao": { "type": "number" } } }, "uiapi.v2AgencyTotalsYear": { "type": "object", "properties": { "ano": { "type": "integer" }, "media_por_membro": { "$ref": "#/definitions/uiapi.perCapitaData" }, "meses": { "type": "array", "items": { "$ref": "#/definitions/uiapi.v2MonthTotals" } }, "orgao": { "$ref": "#/definitions/uiapi.agency" }, "package": { "$ref": "#/definitions/uiapi.backup" } } }, "uiapi.v2MonthTotals": { "type": "object", "properties": { "descontos": { "type": "number" }, "descontos_por_membro": { "type": "number" }, "error": { "$ref": "#/definitions/uiapi.procError" }, "inconsistente": { "type": "boolean" }, "mes": { "type": "integer" }, "outras_remuneracoes": { "type": "number" }, "outras_remuneracoes_por_membro": { "type": "number" }, "remuneracao_base": { "type": "number" }, "remuneracao_base_por_membro": { "type": "number" }, "remuneracoes": { "type": "number" }, "remuneracoes_por_membro": { "type": "number" }, "resumo_rubricas": { "$ref": "#/definitions/uiapi.itemSummary" }, "timestamp": { "$ref": "#/definitions/uiapi.timestamp" }, "total_membros": { "type": "integer" } } }, "uiapi.v2ProcInfoResult": { "type": "object", "properties": { "proc_info": { "$ref": "#/definitions/uiapi.procInfo" }, "timestamp": { "$ref": "#/definitions/uiapi.timestamp" } } } } }