Documentação Técnica

Dados de Empresas nas Proximidades

Descrição

O dataset de Dados de Empresas nas Proximidades contém uma lista de empresas que encontram-se próximas a localidade informada, conforme os filtros aplicados, além de trazer informações simples respectivas à região pesquisada. Para obter as informações, é necessário enviar a latitude e logitude da região a ser pesquisada, juntamente ao raio de pesquisa à partir daquela localização, além de outros filtros presentes neste dataset. Os filtros secundários permitem ao usuário filtrar por diversas características de empresas que ele deseja encontrar como, por exemplo, nome de empresas (ou parte de um nome da empresa), natureza legal e/ou atividade econômica.

Origem da Informação

Este dataset reúne, principalmente, informações que têm origem na Receita Federal do Brasil (e órgãos equivalentes no exterior), coletados diretamente do site da Receita Federal ou através de sites da transparência e divulgação de informações.

Tabela de preços para esse dataset

Dados Entregues no MêsValor por dado em lista retornado
1 - 10000R$ 0,020
10001 - 50000R$ 0,019
50001 - 100000R$ 0,018
100001 - 500000R$ 0,017
500001 - 1000000R$ 0,016
1000001 - 5000000R$ 14.000,00 (preço fixo)
5000001 e acimaEntre em contato

Nota: Os preços da tabela são calculados pela quantidade de dados entregues na listagem do resultado.

Parâmetros de consulta

A tabela abaixo detalha os campos aceitos na consulta a este dataset.

CampoDescriçãoValores PossíveisTipo de Campo
latlongLatitude e longitude de pesquisaCoordenadas da área🛑 Obrigatório
distanceTamanho do raio de pesquisa (Ex.: 5km, 100m, etc.)Valor de distânciaℹ️  Opcional

Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.

Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:

{  
    "Datasets": "companies_data",
    "q": "latlong[lat,long],distance{dist}"  
}  

Filtros

CampoDescrição do filtroTipo do filtroValores Possíveis do Filtro
economicactivitycodesAtividade EconômicaIgualCódigo da Atividade Econômica a ser filtrado. Ex.: 8299706
legalnaturecodesNatureza LegalIgualCódigo da Natureza Legal a ser filtrado. Ex.: 2062
namefilterFiltro pelo NomeContémNome da empresa (ou parte do nome) a ser filtrado. Ex.: Bigdata
employeesrangeRange de FuncionáriosIgualATE 01, 002 A 005, 006 A 009, 010 A 019, 020 A 049, 050 A 099, 100 A 499, >= 500
taxidstatusStatus da EmpresaIgualATIVA, ATIVA - EMPRESA DOMICILIADA NO EXTERIOR, BAIXADA, INAPTA, NULA, NULA - EMPRESA DOMICILIADA NO EXTERIOR, SUSPENSA, SUSPENSA - EMPRESA DOMICILIADA NO EXTERIOR

Abaixo está um exemplo de como utilizar o parâmetro .filter(nome_do_campo=XXXX)

{  
    "Datasets": "companies_data.filter(economicactivitycodes=Código da Atividade Econômica a ser filtrado. Ex.: 8299706)",
    "q": "latlong[lat,long],distance{dist}"  
}  

Limite

Para utilizar o campo de limite basta utilizar o parâmetro .limit(x)
Valor máximo: 100 (empresas)

{  
    "Datasets": "companies_data.limit(10)",
    "q": "latlong[lat,long],distance{dist}"  
}  

Paginação

A paginação do dataset pode ser feita através do parâmetro .next(x), utilizando o ID retornado pela requisição anterior e um parâmetro de consulta q com o mesmo parâmetro inserido na consulta original, conforme o exemplo abaixo:

{  
    "Datasets": "companies_data.next(Id da próxima página)",
    "q": "latlong[lat,long],distance{dist}"  
}  

Campo distance

No campo distance deve ser passado um valor em metros(m) ou quilômetros(km). Os valores devem conter a unidade de medida, por exemplo: se a intenção for consultar as empresas em um raio de 300 metros, no campo distance deve ser informado 300m. Se fossem 2 quilômetros, no campo distance deve ser passado 2km. Na ausência da unidade de medida, consideraremos a unidade como quilômetro(km). Na ausência da distância, consideraremos o padrão 5km como raio. Além disso, é importante salientar que o raio máximo é de 5km ou 5000m, onde qualquer valor passado acima disso será ajustado para o máximo.

Filtros

Os filtros economicactivitycodes, legalnaturecodes e taxidstatus aceitam múltiplos valores como entrada. Ex: companies_data.filter(taxidstatus=[ATIVA,SUSPENSA,INAPTA]). Na ausência do filtro taxidstatus serão retornadas, como padrão, empresas com o status ATIVA.

Language
Credentials
Click Try It! to start a request and see the response here!