Oferece uma forma de acessar à API do Escador por intermédio de CLI feita em Python 3.9.0 e suas bibliotecas que auxiliam na manipulação do protocolo HTTP, a lista desses estão listados em requisitos. O resultado da consulta é um conjunto de dados semiestruturados em formato json.
Armadillo segue a Política de Dados Abertos do Poder Executivo federal, de maneira a aprimorar a cultura de transparência pública, tendo o objetivo de fomentar o controle social e o desenvolvimento de novas tecnologias destinadas à construção de ambiente de gestão pública participativa e democrática e à melhor oferta de serviços públicos para o cidadão.
Observação, o Armillo não solicita nem um meio de pagamentos. Entretanto, pode ocorrer cobrança realizada por terceiros, como a API do Escavador, por isto, consulte as informações pelo site da mesma e aproveite para obter a sua credencial. Além disso, Armillo não realiza a coleta, manipulação dos dados nem proprietário dos mesmos, ou seja, apenas oferece uma interface para acessar os dados do Escavador por intermédio da API do mesmo.
- Abra a pasta
src - Abra o arquivo
main.py - Faça autentificação:
- Realizar a pesquisa:
- O resultado será exportado em um arquivo para a pasta
databasecom o nome"SEARCH".json
O Escavador coleta e compila dados públicos disponíveis em fontes oficiais, desde Diários Oficiais a Tribunais do poder judiciário de todo o Brasil. Integre a API do Escavador ao seu sistema e tenha acesso a informações públicas de pessoas, empresas e processos, disponibilizadas de maneira estruturada.
Utiliza o protocolo OAuth 2.0 para autenticação e autorização, permitindo que aplicações enviem solicitações autenticadas em nome de usuários individuais do Escavador.
O access_token recebido deve ser utilizado no cabeçalho das outras requisições, para que a API identifique o usuário. O token de acesso tem vida útil limitada (valor retornado no campo expires_in) e caso expire, será necessário obter um novo token repetindo esta requisição.
O Bearer identifica recursos protegidos por um OAuth2.0. No qual o deve ser um string, que representa uma autorização do Server emitida para o client. Por sua vez, o client deve possuir mecanismos próprios para identificar e validar o Token.
| Parâmetro | Status | Descrição |
|---|---|---|
| q | obrigatório | O termo a ser pesquisado. Você pode pesquisar entre aspas duplas para match perfeito. |
| qo | obrigatório | Tipo da entidade a ser pesquisada. os valores podem ser: ⏺ t: Para pesquisar todos os tipos de entidades. ⏺ p: Para pesquisar apenas as pessoas. ⏺ i: Para pesquisar apenas as instituições. ⏺ pa: Para pesquisar apenas as patentes. ⏺ d: Para pesquisar apenas os Diários Oficiais. ⏺ en: Para pesquisar as pessoas e instituições que são envolvidas em processos. |
| limit | opcional | Número de itens que serão retornados por página. Default: 20 |
| page | opcional | Número da página, respeitando o limite informado. |
Fique à vontade para contribuir com o projeto, toda contribuição é bem vinda. Sendo possível contribuir de 3 formas: issues, pull requests e revisar pull requests.