Baixar Collection

Busca - Escavador API - Documentação

Grupo

Busca

Buscar por termo

GET /api/v1/busca
Requer autenticaçãoPaga

Pesquisa um termo no Escavador.

O resultado da pesquisa pode incluir pessoas, instituições e diários oficiais, dependendo dos parâmetros fornecidos.

O endpoint suporta pesquisas avançadas utilizando operadores lógicos para refinar os resultados.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: GET.

Query Parameters

?
q string Obrigatório

O termo a ser pesquisado. Você pode pesquisar entre aspas duplas para match perfeito.

Se o parâmetro utilizar_operadores_logicos=1 for informado, você pode tilizar os operados lógicos AND, OR e NOT para pesquisas avançadas e agrupar condições usando parênteses:

João AND Silva: retornará resultados que incluem ambos os termos "João" e "Silva".
(João OR Silva) AND Maria: retornará resultados que incluem o termo "Maria" e pelo menos um dos termos "João" ou "Silva".
"Maria Silva" AND ("João Silva" OR "José Silva") AND NOT "santos": retornará resultados que incluem "Maria Silva" e pelo menos um dos termos "João Silva" ou "José Silva" e que não incluem o termo "santos".

qo string 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.
c: Retorna a lista de pessoas, com os respectivos ids no Escavador.
i: Para pesquisar apenas as instituições.
d: Para pesquisar apenas os Diários Oficiais.
en: Para pesquisar as pessoas e instituições que são envolvidas em processos.

qs string Opcional

Se o parâmetro qo (tipo da entidade) for igual a 'd' (Diário Oficial), você pode definir a ordenação dos resultados da pesquisa. Os valores podem ser:

d: Ordena os resultados do mais recente para o mais antigo.
a: Ordena os resultados do mais antigo para o mais recente.

limit integer Opcional

Número de itens que serão retornados por página. Default: 20

page integer Opcional

Número da página, respeitando o limite informado.

utilizar_operadores_logicos integer Opcional

0 para pesquisa normal e 1 para pesquisa avançada. Default: 0

Exemplos de respostas válidas

HTTP 200 ? 
{
    "paginator": {
        "total": 4,
        "total_pages": 1,
        "current_page": 1,
        "per_page": 20
    },
    "links": {
        "prev": null,
        "next": "https://api.escavador.com/api/v1/busca?q=João da Silva&qo=t&page=2"
    },
    "items": [
        {
            "id": 4236069,
            "diario_id": 4236069,
            "numero_pagina": 31,
            "diario_sigla": "DOMNAT-RN",
            "diario_nome": "Diário Oficial do Município de Natal (Rio Grande do Norte)",
            "diario_data": "2011-08-12",
            "caderno": "Padrão",
            "caderno_url": "P",
            "texto": " JOAO SILVA...",
            "diario_edicao": "2094",
            "link": "https://www.escavador.com/diarios/4236069/DOMNAT-RN/P/2011-08-12?page=31",
            "link_api": "https://api.escavador.com/api/v1/diarios/4236069?page=31",
            "tipo_resultado": "Diario"
        },
        {
            "id": 13115517,
            "nome": "João Silva",
            "resumo": "De acordo com os dados indexados: João Silva Santos ...",
            "atuacao_formacao": null,
            "areas_atuacao": null,
            "nome_em_citacoes": null,
            "quantidade_processos": 90,
            "tipos_juridico": [
                {
                    "label": "REQUERENTE",
                    "quantidade_processos": 14
                },
                {
                    "label": "AUTOR",
                    "quantidade_processos": 14
                },
                {
                    "label": "RECLAMANTE",
                    "quantidade_processos": 10
                },
                {
                    "label": "REQUERIDO",
                    "quantidade_processos": 7
                },
                {
                    "label": "EXECUTADO",
                    "quantidade_processos": 6
                },
                {
                    "label": "APELANTE",
                    "quantidade_processos": 6
                },
                {
                    "label": "AGRAVADO",
                    "quantidade_processos": 5
                },
                {
                    "label": "RECORRIDO",
                    "quantidade_processos": 4
                },
                {
                    "label": "RECORRENTE",
                    "quantidade_processos": 3
                },
                {
                    "label": "INVTARDO",
                    "quantidade_processos": 2
                }
            ],
            "tem_processo": 1,
            "slug": "joao-silva",
            "url_id": 13337879,
            "link": "https://www.escavador.com/sobre/13337879/joao-silva",
            "link_api": "https://api.escavador.com/api/v1/pessoas/13115517",
            "tipo_resultado": "Pessoa",
            "oab_numero": [
                "1234"
            ],
            "tem_curriculo": 0,
            "updated_at": "2022-08-09 06:41:42",
            "tem_patente": 0
        },
        {
            "id": 7372109,
            "nome": "Joao Silva Company",
            "resumo": "De acordo com os dados indexados: Joao Silva Company possui 622 processos indexados, até então, pelo Escavador. Com 492 processos no Estado de São Paulo...",
            "sigla": "",
            "pais": "Brasil",
            "quantidade_pessoas": 0,
            "quantidade_processos": 622,
            "tipos_juridico": [
                {
                    "label": "REQUERIDO",
                    "quantidade_processos": 312
                },
                {
                    "label": "POLO PASSIVO",
                    "quantidade_processos": 61
                },
                {
                    "label": "RÉU",
                    "quantidade_processos": 28
                },
                {
                    "label": "TERCEIRO INTERESSADO",
                    "quantidade_processos": 18
                },
                {
                    "label": "RECLAMADO",
                    "quantidade_processos": 17
                },
                {
                    "label": "RECORRIDO",
                    "quantidade_processos": 14
                },
                {
                    "label": "AGRAVADO",
                    "quantidade_processos": 9
                },
                {
                    "label": "RECORRENTE",
                    "quantidade_processos": 7
                },
                {
                    "label": "APELADO",
                    "quantidade_processos": 4
                },
                {
                    "label": "INTERESSADO",
                    "quantidade_processos": 2
                }
            ],
            "tem_processo": 1,
            "slug": "njoao-silva-company",
            "url_id": 227162960,
            "link": "https://www.escavador.com/sobre/227162960/joao-silva-company",
            "link_api": "https://api.escavador.com/api/v1/instituicoes/7372109",
            "tipo_resultado": "Instituicao",
            "updated_at": "2022-08-12 06:42:34",
            "tem_patente": 0
        }
    ]
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 402 ? 
{
    "error": "Você não possui saldo em crédito da API."
}
HTTP 404 ? 
{
    "error": "NotFound"
}