API V2 Economapas - Documentação
A API V1 foi descontinuada em 31/01/2023.
Geral
Esta é a documentação de uso da API Economapas. Baixe nosso Book de Dados Economapas caso queira consultar o detalhamento dos campos disponíveis. Atente-se às instruções fornecidas e caso seja necessário, nossa equipe estará pronta para ajudar!
Autenticação
A autenticação deverá ser feita através de um Token API e deverá ser passado através de Bearer HTTP Auth.
Como gerar um token?
O Token API deverá ser feito através do Painel de Controle da API, na aplicação Economapas.
Caso você não tenha gerado um token ainda, a tela deverá mostrar uma mensagem o informando da condição (conforme figura abaixo)
Caso você já tenha gerado um token, seu painel estará conforme imagem abaixo. Dessa forma, você deverá copiar o token para utilizá-lo no header da requisição.
Lembrando que a qualquer momento você pdoerá gerar um novo token clicando em Gerar Novo Token.
Header
cURL
$ curl <Verbo HTTP> 'https://api.economapas.com.br/v2/<endpoint>'
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
Padrões de Resposta
JSON
{
"status": 1,
"content": {
[conteúdo]
}
}
HTTP Status: 200 OK
JSON
{
"status": 0,
"content": {
"mensagem": {
[mensagem]
}
}
}
HTTP Status: 40X CLIENT ERROR
O status funciona da seguinte forma: 0 para fracasso, sendo ele qualquer comportamento fora do esperado onde a resposta não tem relação com o pedido; 1 para sucesso, sendo sucesso o resultado esperado.
O retorno mensagem é descritivo sobre o erro ocorrido, sendo sempre retornado em texto.
Endpoints
Os campos em destaque e com a sinalização * são campos obrigatórios na requisição.
Ponto/Raio
Com o endpoint de Ponto/Raio você poderá consultar informações categorizadas de uma determinada região ou ponto préviamente definido no Economapas (via plataforma (UI) ou via API).
Dados de Coordenadas - Campos Disponíveis
https://api.economapas.com.br/v2/pr/dados/campos/<modulo>
Gratuito.
| Campo | Descrição |
|---|---|
| modulo | Campo que representa o módulo dos dados que deseja receber. Os módulos são: socioeconomico, consumo, empresas, anp, anp-glp, escola, faculdade, mooh, agro, delivery, graduacao e frota. |
{
"status": 1,
"content": {
"campos_disponiveis": [
"fluxo",
"pop_total_fluxo",
"fat_a1_flutuante",
"fat_a2_flutuante",
]
}
}
Dados de Coordenadas
https://api.economapas.com.br/v2/pr/dados
Conforme contratação.
| Campo | Descrição |
|---|---|
| tipo | O tipo de local onde a busca será realizada. Pode ser coords, endereco, cnpj ou cep.
Para coords, deverá ser passada uma latitude e longitude válida e de uma localidade permitida em seu usuário. Um raio também pode ser definido (default: 1000 metros); Para endereco, deverá ser passado um endereco válido. (Ex.: R. Halfeld, 882 - Centro, Juiz de Fora - MG); Para cnpj, deverá ser passada um cnpj válido e ativo; Para cep, deverá ser passada um cep válido; Obs: o parâmetro considerado será somente os referentes ao que for assinalado no parâmetro tipo. (Ex: caso seja assinalada coords, somente os parâmetros latitude e longitude serão considerados e qualquer outro parâmentro será desconsiderado). |
| modulo | Campo que representa o módulo dos dados que deseja receber. Os módulos são: socioeconomico, consumo, empresas, anp, anp-glp, escola, faculdade, mooh, agro, delivery, graduacao e frota. |
| campos | Apenas os campos especificados na requisição serão retornados e cobrados. Ex.: ["autopeças", "fluxo", "1.01.01_consumo_total"]. Caso queira retornar todos os dados, passe "all" em campos na requisição (apenas para módulo socioeconomico). Ex.: ["all"]. Obs.: Caso tenha dúvidas sobre quais campos escolher, consulte as rotas equivalentes para a listagem. |
| latitude | Campo que representa a latitude da coordenada cujas informações serão coletadas. |
| longitude | Campo que representa a longitude da coordenada cujas informações serão coletadas. |
| endereco | Campo que representa o endereço da coordenada cujas informações serão coletadas. |
| cnpj | Campo que representa o CNPJ da coordenada cujas informações serão coletadas. |
| cep | Campo que representa o CEP da coordenada cujas informações serão coletadas. |
| raio | Campo que representa o raio a partir do ponto definido com a latitude e longitude da coordenada cujas informações serão coletadas. O dado precisa ser passado no formato numérico, inteiro e dentro do range permitido em sua conta, sendo 5.000 metros como padrão e 25.000 metros para quem possui a função Raio Extra. Caso este campo não seja incluído, o Economapas calculará o ponto com o padrão de 1000 metros. |
{
"status": 1,
"content": {
"fluxo": 65135,
"pop_total_fluxo": 19964,
"1.01.03_consumo_a1_fixa": 184239886.29549,
"1.01.03_consumo_a2_fixa": 169940968.02902,
"1.01.03_consumo_b1_fixa": 161928082.04035,
"1.01.03_consumo_b2_fixa": 138357080.55709,
"1.01.03_consumo_c1_fixa": 279756125.40311,
"1.01.03_consumo_c2_fixa": 96522457.597754,
"1.01.03_consumo_d_fixa": 22746742.87153,
"1.01.03_consumo_e_fixa": 4423736.9120615,
"1.01.03_consumo_a_fixa": 354180854.32452,
"1.01.03_consumo_b_fixa": 300285162.59745,
"1.01.03_consumo_c_fixa": 376278583.00087,
"1.01.03_consumo_de_fixa": 27170479.783592
}
}
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.economapas.com.br/v2/pr/dados');
$post = json_encode(array(
'tipo': 'coords',
'latitude' => '-22.9365510',
'longitude' => '-43.1863928',
'modulo' => 'socioeconomico',
'campos' => [
"fluxo",
"pop_total_fluxo",
"1.01.03_consumo_a1_fixa",
"1.01.03_consumo_a2_fixa",
"1.01.03_consumo_b1_fixa",
"1.01.03_consumo_b2_fixa",
"1.01.03_consumo_c1_fixa",
"1.01.03_consumo_c2_fixa",
"1.01.03_consumo_d_fixa",
"1.01.03_consumo_e_fixa",
"1.01.03_consumo_a_fixa",
"1.01.03_consumo_b_fixa",
"1.01.03_consumo_c_fixa",
"1.01.03_consumo_de_fixa"
]
));
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json", "Accept: application/json", "Authorization: Bearer *token"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$data = json_decode(curl_exec($ch));
curl_close($ch);
}
curl -X POST https://api.economapas.com.br/v2/pr/dados
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer *token"
-d '{
"tipo": "coords",
"latitude": "-22.9365510",
"longitude": "-43.1863928",
"modulo": "socioeconomico",
"campos": [
"fluxo",
"pop_total_fluxo",
"1.01.03_consumo_a1_fixa",
"1.01.03_consumo_a2_fixa",
"1.01.03_consumo_b1_fixa",
"1.01.03_consumo_b2_fixa",
"1.01.03_consumo_c1_fixa",
"1.01.03_consumo_c2_fixa",
"1.01.03_consumo_d_fixa",
"1.01.03_consumo_e_fixa",
"1.01.03_consumo_a_fixa",
"1.01.03_consumo_b_fixa",
"1.01.03_consumo_c_fixa",
"1.01.03_consumo_de_fixa"
]
}'
Dados de Pontos
https://api.economapas.com.br/v2/pr/dados/<id_ponto>
Conforme contratação.
| Campo | Descrição |
|---|---|
| id_ponto | Parâmetro na URL que representa o ponto no qual os dados serão requisitados. Esse ponto deve pertencer à sua conta e estar devidamente cadastrado. Toda informação retornada levará em consideração os dados do ponto requisitado, como latitude, longitude, raio/área e afins. |
| modulo | Campo que representa o módulo dos dados que deseja receber. Os módulos são: socioeconomico, consumo, empresas, anp, anp-glp, escola, faculdade, mooh, agro, delivery, graduacao e frota. |
| campos | Apenas os campos especificados na requisição serão retornados e cobrados. Ex.: ["autopeças", "fluxo", "1.01.01_consumo_total"]. Caro queira retornar todos os dados, passe "all" em campos na requisição. Ex.: ["all"]. Obs.: Caso tenha dúvidas sobre quais campos escolher, consulte as rotas equivalentes para a listagem. |
{
"status": 1,
"content": {
"fluxo": 128044,
"pop_total_fluxo": 27307,
"1.01.03_consumo_a1_fixa": 563297044.70444,
"1.01.03_consumo_a2_fixa": 406321069.1234,
"1.01.03_consumo_b1_fixa": 438799687.56307,
"1.01.03_consumo_b2_fixa": 429102603.54017,
"1.01.03_consumo_c1_fixa": 975670570.58227,
"1.01.03_consumo_c2_fixa": 265850505.79958,
"1.01.03_consumo_d_fixa": 61990103.549718,
"1.01.03_consumo_e_fixa": 11138540.372928,
"1.01.03_consumo_a_fixa": 969618113.82784,
"1.01.03_consumo_b_fixa": 867902291.10324,
"1.01.03_consumo_c_fixa": 1241521076.3819,
"1.01.03_consumo_de_fixa": 73128643.922646
}
}
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.economapas.com.br/v2/pr/dados/*id_ponto');
$post = json_encode(array(
'modulo' => 'socioeconomico',
'campos' => [
"fluxo",
"pop_total_fluxo",
"1.01.03_consumo_a1_fixa",
"1.01.03_consumo_a2_fixa",
"1.01.03_consumo_b1_fixa",
"1.01.03_consumo_b2_fixa",
"1.01.03_consumo_c1_fixa",
"1.01.03_consumo_c2_fixa",
"1.01.03_consumo_d_fixa",
"1.01.03_consumo_e_fixa",
"1.01.03_consumo_a_fixa",
"1.01.03_consumo_b_fixa",
"1.01.03_consumo_c_fixa",
"1.01.03_consumo_de_fixa"
]
));
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json", "Accept: application/json", "Authorization: Bearer *token"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$data = json_decode(curl_exec($ch));
curl_close($ch);
}
curl -X POST https://api.economapas.com.br/v2/pr/dados/*id_ponto
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer *token"
-d '{
"modulo": "socioeconomico",
"campos": [
"fluxo",
"pop_total_fluxo",
"1.01.03_consumo_a1_fixa",
"1.01.03_consumo_a2_fixa",
"1.01.03_consumo_b1_fixa",
"1.01.03_consumo_b2_fixa",
"1.01.03_consumo_c1_fixa",
"1.01.03_consumo_c2_fixa",
"1.01.03_consumo_d_fixa",
"1.01.03_consumo_e_fixa",
"1.01.03_consumo_a_fixa",
"1.01.03_consumo_b_fixa",
"1.01.03_consumo_c_fixa",
"1.01.03_consumo_de_fixa"
]
}'
Mapas
Com o endpoint de Mapas você poderá consultar informações socioeconomicas, de consumo e/ou de filtros do Economapas via API.
Cidades / Estados Disponíveis
https://api.economapas.com.br/v2/mapas/locais/<modulo>
Gratuito.
| Campo |
|---|
| cidades |
| ufs |
{
"status":1,
"content":{
"cidades":{
"[UF]": {
[lista de cidades]
}
}
}
}
Dados de Cidade - Campos Disponíveis
https://api.economapas.com.br/v2/mapas/dados/cidade/campos/<modulo>
Gratuito.
| Campo | Descrição |
|---|---|
| modulo | Campo que representa o módulo dos dados que deseja receber. Os módulos são: socioeconomico, consumo, empresas, anp, anp-glp, escola, faculdade, mooh, agro, delivery, graduacao e frota. |
{
"status": 1,
"content": {
"campos_disponiveis": [
"nome",
"mun_uf",
"num_domicilios",
"num_domicilios_aluguel",
"pop_total"
]
}
}
Dados de UF - Campos Disponíveis
https://api.economapas.com.br/v2/mapas/dados/uf/campos/<modulo>
Gratuito.
| Campo | Descrição |
|---|---|
| modulo | Campo que representa o módulo dos dados que deseja receber. Os módulos são: socioeconomico, consumo, empresas, anp, anp-glp, escola, faculdade, mooh, agro, delivery, graduacao e frota. |
{
"status": 1,
"content": {
"campos_disponiveis": [
"uf_nome",
"uf",
"mun_uf",
"num_domicilios",
"num_domicilios_aluguel",
"pop_total",
"estabs_vest"
]
}
}
Dados de Cidade
https://api.economapas.com.br/v2/mapas/dados/cidade
Conforme contratação.
| Campo | Descrição |
|---|---|
| cidade | Nome da cidade que os dados serão retornados. |
| uf | Nome da UF que os dados serão retornados. |
| modulo | Campo que representa o módulo dos dados que deseja receber. Os módulos são: socioeconomico, consumo, empresas, anp, anp-glp, escola, faculdade, mooh, agro, delivery, graduacao e frota. |
| campos | Apenas os campos especificados na requisição serão retornados e cobrados. Ex.: ["autopeças", "fluxo", "1.01.01_consumo_total"]. Caro queira retornar todos os dados, passe "all" em campos na requisição. Ex.: ["all"]. Obs.: Caso tenha dúvidas sobre quais campos escolher, consulte as rotas equivalentes para a listagem. |
{
"status": 1,
"content": {
"1.01.01_consumo_total": 847900842.20204,
"1.01.02_consumo_a1_fixa": 335801325.94875
}
}
Dados de UF
https://api.economapas.com.br/v2/mapas/dados/uf
Conforme contratação.
| Campo | Descrição |
|---|---|
| uf | Nome da UF que os dados serão retornados. |
| modulo | Campo que representa o módulo dos dados que deseja receber. Os módulos são: socioeconomico, consumo, empresas, anp, anp-glp, escola, faculdade, mooh, agro, delivery, graduacao e frota. |
| campos | Apenas os campos especificados na requisição serão retornados e cobrados. Ex.: ["autopeças", "fluxo", "1.01.01_consumo_total"]. Caro queira retornar todos os dados, passe "all" em campos na requisição. Ex.: ["all"]. Obs.: Caso tenha dúvidas sobre quais campos escolher, consulte as rotas equivalentes para a listagem. |
{
"status": 1,
"content": {
"pop_0_4": "769839",
"pop_5_9": "851730",
"pop_10_14": "1016981",
"pop_15_19": "1013495",
"pop_20_24": "1036729",
"pop_25_29": "1084754",
"pop_30_34": "1527253",
"pop_35_39": "1373817",
"pop_40_44": "1317892",
"pop_45_49": "1268547",
"pop_50_54": "1148913"
}
}
Meus Pontos
Com os endpoints de Meus Pontos você poderá consultar, criar, editar e deletar pontos no Economapas via API.
Consultar Cota de Pontos
https://api.economapas.com.br/v2/pr/pontos/consulta
Gratuito.
| Não há parâmetros necessários nessa requisição. |
{
"status": 1,
"content": {
"cota": {
"total": 1000,
"usado": 1,
"disponivel": 999
},
"possivel": 1
}
}
Consultar Ponto
https://api.economapas.com.br/v2/pr/ponto/<id_ponto>
Gratuito.
| Campo | Descrição |
|---|---|
| id_ponto | Parâmetro na URL que representa o ponto no qual os dados serão retornados. |
| inputs | Parâmetro na URL (Query Param) booleano que habilita os valores de inputs para o ponto. Para habilitar, basta passar como true. Por padrão a opção é desabilitada. |
{
"status": 1,
"content": {
"id": 1,
"nome": "Ponto",
"descricao": "Exemplo de ponto",
"latitude": "-21.7624237",
"longitude": "-43.3433999",
"raio": 0,
"municipio": "JUIZ DE FORA",
"uf": "MG",
"categoria": {
"id": 0,
"nome": "Geral"
},
"data_criacao": "2021-01-01"
}
}
Consultar Todos Meus Pontos
https://api.economapas.com.br/v2/pr/pontos
Gratuito.
| Campo | Descrição |
|---|---|
| por_pagina | Filtro de registros retornados por página. O range vai de 10 a 50. Caso não seja passado, o número de registros padrão é de 20. |
| pagina | Parâmetro de página para ser retornada. O total de páginas que uma consulta possui é retornada na primeira requisição como total_paginas. |
{
"status": 1,
"content": {
"type": "list",
"data": [
{
"id": 1,
"nome": "Ponto",
"descricao": "Exemplo de ponto",
"latitude": "-21.7624237",
"longitude": "-43.3433999",
"raio": 0,
"municipio": "JUIZ DE FORA",
"uf": "MG",
"categoria": {
"id": 0,
"nome": "Geral"
},
"data_criacao": "2021-01-01"
}
],
"pagina": 1,
"por_pagina": 20,
"total_paginas": 1,
"total_pontos": 1
}
}
Inserir Ponto por Coordenadas
https://api.economapas.com.br/v2/pr/ponto/coords
Gratuito.
| Campo | Descrição |
|---|---|
| nome | Nome do ponto a ser inserido. Recomendamos que o nome seja descritivo pois o mesmo poderá ser visualizado na plataforma. |
| latitude | Latitude do ponto a ser definido. |
| longitude | Longitude do ponto a ser definido. |
| raio | Raio do ponto a ser inserido, que deverá ser enviado com numérico entre 0 e até o limite disponível em sua conta, que é de 5.000 metros para contas padrão e 25.000 metros para contas com Raio Extra. Em caso de indefinição, o raio adotado pelo Economapas será o padrão de 500 metros. |
| descricao | Descrição textual do ponto a ser inserido. Em caso de não preenchimento, a descrição ficará vazia. |
| id_categoria | Id da Categoria a qual o ponto pertencerá. Caso não seja preenchida, o ponto ficará na categoria geral. |
{
"status": 1,
"content": {
"message": "Ponto #852898 criado com sucesso!",
"data": {
"id": 852898,
"nome": "Exemplo 2",
"descricao": "Exemplo 2",
"responsavel": "Chip",
"latitude": "-21.7483500",
"longitude": "-43.3585240",
"raio": 1000,
"municipio": "JUIZ DE FORA",
"uf": "MG",
"categoria": {
"id": 0,
"nome": "Geral"
},
"data_criacao": "2021-02-11"
},
"parcial": {
"total": 1000,
"disponivel": 998
}
}
}
Atualizar Ponto
https://api.economapas.com.br/v2/pr/ponto/<id_ponto>
Gratuito.
| Campo | Descrição |
|---|---|
| id_ponto | Id do Ponto a ser editado. |
| nome | Nome do ponto a ser editado. Recomendamos que o nome seja descritivo pois o mesmo poderá ser visualizado na plataforma. |
| latitude | Latitude do ponto a ser editado. |
| longitude | Longitude do ponto a ser editado. |
| raio | Raio do ponto a ser editado, que deverá se manter com numérico entre 0 e até o limite disponível em sua conta, que é de 5.000 metros para contas padrão e 25.000 metros para contas com Raio Extra. |
| descricao | Descrição textual do ponto a ser inserido. |
{
"status": 1,
"content": {
"message": "Ponto atualizado com sucesso",
"data": {
"id": 852898,
"nome": "Exemplo 2 Editado",
"descricao": "Exemplo 2 foi editado",
"responsavel": "Chip",
"latitude": "-21.7483500",
"longitude": "-43.3585240",
"raio": 1000,
"municipio": "JUIZ DE FORA",
"uf": "MG",
"categoria": {
"id": 0,
"nome": "Geral"
},
"data_criacao": "2021-02-11"
}
}
}
Deletar Ponto
https://api.economapas.com.br/v2/pr/ponto/<id_ponto>
Gratuito.
Essa ação não poderá ser desfeita.
| Campo | Descrição |
|---|---|
| id_ponto | Id do Ponto a ser deletado. |
{
"status": 1,
"content": {
"deleted": true
}
}
Minhas Categorias
Com os endpoints de Minhas Categorias você poderá consultar, criar, editar e deletar categorias no Economapas via API.
Consultar Todas Minhas Categorias
https://api.economapas.com.br/v2/pr/categorias
Gratuito.
| Não há parâmetros necessários nessa requisição. |
{
"status": 1,
"content": {
"type": "list",
"data": [
{
"id": "37795",
"nome": "Estudos",
"descricao": "",
"responsavel": "Chip",
"data_criacao": "01-01-2021"
},
{
"id": "37796",
"nome": "Minhas lojas",
"descricao": "",
"responsavel": "Chip",
"data_criacao": "01-01-2021"
},
{
"id": "37797",
"nome": "Lojas franqueadas",
"descricao": "",
"responsavel": "Chip",
"data_criacao": "01-01-2021"
},
{
"id": "37798",
"nome": "Concorrentes",
"descricao": "",
"responsavel": "Chip",
"data_criacao": "01-01-2021"
},
{
"id": "37799",
"nome": "Clientes",
"descricao": "",
"responsavel": "Chip",
"data_criacao": "01-01-2021"
},
{
"id": "37800",
"nome": "Parceiros",
"descricao": "",
"responsavel": "Chip",
"data_criacao": "01-01-2021"
},
{
"id": "37801",
"nome": "Fornecedores",
"descricao": "",
"responsavel": "Chip",
"data_criacao": "01-01-2021"
}
],
"total_categorias": "7"
}
}
Consultar Categoria
https://api.economapas.com.br/v2/pr/categoria/<id_categoria>
Gratuito.
| Campo | Descrição |
|---|---|
| id_categoria | Parâmetro na URL que representa a categoria na qual os dados serão retornados. |
{
"status": 1,
"content": {
"data": {
"id": 37795,
"nome": "Estudos",
"descricao": "",
"responsavel": "Chip",
"data_criacao": "01-01-2021"
}
}
}
Inserir Categoria
https://api.economapas.com.br/v2/pr/categoria
Gratuito.
| Campo | Descrição |
|---|---|
| nome | Nome da categoria a ser inserida. |
| descricao | Descrição da categoria a ser inserida. |
{
"status": 1,
"content": {
"message": "Categoria #59348 criada com sucesso!",
"data": {
"id": 59348,
"nome": "Categoria Exemplo",
"descricao": "",
"responsavel": "Chip",
"data_criacao": "01-01-2021"
}
}
}
Atualizar Categoria
https://api.economapas.com.br/v2/pr/categoria/<id_categoria>
Gratuito.
| Campo | Descrição |
|---|---|
| nome | Nome da categoria a ser editada. |
| descricao | Descrição da categoria a ser editada. |
{
"status": 1,
"content": {
"message": "Categoria atualizada com sucesso",
"data": {
"data": {
"id": 59348,
"nome": "Categoria Exemplo Editada",
"descricao": "Categoria editada",
"responsavel": "Chip",
"data_criacao": "01-01-2021"
}
}
}
}
Deletar Categoria
https://api.economapas.com.br/v2/pr/categoria/<id_categoria>
Gratuito.
Essa ação não poderá ser desfeita.
| Campo | Descrição |
|---|---|
| id_categoria | Parâmetro na URL que representa a categoria que deverá ser deletada. |
Obs: uma vez que uma categoria é excluída, os pontos que antes as pertenciam passará a pertencer à categoria geral.
{
"status": 1,
"content": {
"deleted": true
}
}
Meus Inputs
Com os endpoints de Meus Inputs você poderá consultar e atualizar dados de Inputs no Economapas via API.
Consultar Inputs Criados
https://api.economapas.com.br/v2/pr/inputs
Gratuito.
Este endpoint retorna a lista de inputs disponíveis para o usuário.
| Campo | Descrição |
|---|---|
| por_pagina | Filtro de registros retornados por página. O range vai de 10 a 50. Caso não seja passado, o número de registros padrão é de 20. |
| pagina | Parâmetro de página para ser retornada. O total de páginas que uma consulta possui é retornada na primeira requisição como total_paginas. |
Alterar Valor de Input de um Ponto
https://api.economapas.com.br/v2/pr/input/<id_input>
Gratuito.
Este endpoint atualiza o valor de input de um ponto.
| Campo | Descrição |
|---|---|
| id_ponto | Id do ponto cujo input será atualizado. |
| valor | Valor para atualizar o input indicado do ponto |
Leads
Com os endpoints de Leads você poderá buscar leads de diversas formas em diferentes localidades ao seu critério.
Google Pro - Campos Disponíveis
https://api.economapas.com.br/v2/leads/google_pro/campos
Gratuito.
| Não há parâmetros necessários nessa requisição. |
{
"status": 1,
"content": {
"campos_disponiveis": [
"nome",
"endereco",
"latitude",
"longitude"
]
}
}
Busca Web - Campos Disponíveis
https://api.economapas.com.br/v2/leads/busca_web/campos
Gratuito.
| Não há parâmetros necessários nessa requisição. |
{
"status": 1,
"content": {
"campos_disponiveis": [
"nome",
"endereco",
"preco",
"n_reviews"
]
}
}
CNPJs - Campos Disponíveis
https://api.economapas.com.br/v2/leads/cnpjs/campos
Gratuito.
| Não há parâmetros necessários nessa requisição. |
{
"status": 1,
"content": {
"campos_disponiveis": [
"razao_social",
"nome_fantasia",
"cnpj",
"cnae",
"opcionais_indice_atividade"
]
}
}
CNPJs Total - Campos Disponíveis
https://api.economapas.com.br/v2/leads/cnpjs/total/campos
Gratuito.
| Não há parâmetros necessários nessa requisição. |
{
"status": 1,
"content": {
"campos_disponiveis": [
"total"
]
}
}
Google Pro
https://api.economapas.com.br/v2/leads/google_pro
Conforme contratação.
Este endpoint retorna resultados baseado no Google Places de acordo com a localidade definida.
| Campo | Descrição |
|---|---|
| tipo | O tipo de local onde a busca será realizada. Pode ser coords, ponto, cidade ou uf.
Para coords, deverá ser passada uma latitude e longitude válida e de uma localidade permitida em seu usuário. Um raio também pode ser definido (default: 1000 metros); Para ponto, deverá ser passado um id com o id de um de seus pontos definidos no Economapas; Para cidade, deverá ser passada uma cidade no padrão [nome da cidade] - [uf] (ex: Rio de Janeiro - RJ). A cidade deverá ser válida e estar inclusa em seu plano; Para uf, deverá ser passada uma uf válida e disponível no plano, juntamente com a função do economapas visão uf. Obs: o parâmetro considerado será somente os referentes ao que for assinalado no parâmetro tipo. (Ex: caso seja assinalado ponto, somente o parâmetro ponto será considerado e qualquer outro parâmentro será desconsiderado.) |
| latitude | Latitude da coordenada a ser realizada a busca. Obrigatória quando o tipo for coords. |
| longitude | Longitude da coordenada a ser realizada a busca. Obrigatória quando o tipo for coords. |
| id | Id do ponto cadastrado no Economapas onde será realizada a busca. Obrigatória quando o tipo for ponto. |
| cidade | Nome da cidade a ser realizada a busca, necessitando tê-la inclusa em seu plano Economapas. O padrão deverá ser [nome da cidade] - [uf da cidade] (Ex: São Paulo - SP). Obrigatória quando o tipo for cidade. |
| uf | Sigla da uf ser realizada a busca, necessitando tê-la inclusa em seu plano Economapas juntamente com a função visão de estado. Obrigatória quando o tipo for uf. |
| filtro (filtro/termo, um dos dois deve ser passado obrigatoriamente) | Categoria pré-definida de busca. Filtros padrão: academia, aeroporto, agencia_de_viagens, banco, bar, boate, cafe, caixa_eletronico, loja_de_calcados, chaveiro, cinema, concessionaria, contabilidade, loja_de_conveniencia, correio, delivery, eletricista, loja_de_eletronicos, escola, estacionamento, salao_de_beleza, universidade, farmacia, fisioterapia, floricultura, funeraria, bombeiro_hidraulico, hospital, hotel, igreja, imobiliaria, joalheria, lava_jato, livraria, locadora_de_carros, loja_departamento, material_de_construcao, medico, estacao_trem_metro, loja_de_moveis, fretes_e_mudancas, museu, dentista, oficina_mecanica, parada_de_onibus, padaria, parque_de_diversoes, petshop, policia, posto_de_combustiveis, restaurante, seguradora, shopping, supermercado, loja_de_vestiveis e veterinaria. |
| termo (filtro/termo, um dos dois deve ser passado obrigatoriamente) | Termo livre para busca. |
| campos | Apenas os campos especificados na requisição serão retornados e cobrados. Ex.: ["autopeças", "fluxo", "1.01.01_consumo_total"]. Caro queira retornar todos os dados, passe "all" em campos na requisição. Ex.: ["all"]. Obs.: Caso tenha dúvidas sobre quais campos escolher, consulte as rotas equivalentes para a listagem. |
| raio | Raio em metros a partir da coordenada informada. Caso não seja informada no contexto do tipo coords, o padrão será de 1000 metros; |
| limite | Limite de resultados a serem retornados. As possibilidades são de 20, 40 ou 60 resultados, sendo cobrado a cada intervalo de 20. Em caso de indefinição, o padrão é 20 resultados. |
| detalhes | Retorno de detalhes a respeito dos locais encontrados na busca. Sua cobrança é a parte e é condicionada ao número de resultados cujos detalhes foram de fato encontrados. |
{
"status": 1,
"content": [
{
"nome": "SENAI Juiz de Fora CFP José Fagundes Netto",
"endereco": "Avenida Barão do Rio Branco, 1219 - Centro, Juiz de Fora",
"latitude": "-21.7524141",
"longitude": "-43.35164",
"is_open": true,
"preco": "ND",
"n_reviews": 28,
"rating": 4.7,
"detalhes": {
"telefone": "(32) 3239-2233",
"horarios": [
"segunda-feira: 08:00 – 22:00",
"terça-feira: 08:00 – 22:00",
"quarta-feira: 08:00 – 22:00",
"quinta-feira: 08:00 – 22:00",
"sexta-feira: 08:00 – 22:00",
"sábado: Fechado",
"domingo: Fechado"
],
"url_maps": "https://maps.google.com/?cid=12730072879317690357"
}
},
{
"nome": "Colégio de Aplicação João XXIII",
"endereco": "Rua Visconde de Mauá, 300 - Santa Helena, Juiz de Fora",
"latitude": "-21.755746",
"longitude": "-43.3594855",
"is_open": null,
"preco": "ND",
"n_reviews": 63,
"rating": 4.5
},
{
"nome": "Museu Mariano Procópio",
"endereco": "Rua Mariano Procópio, 1100 - Mariano Procópio, Juiz de Fora",
"latitude": "-21.7476327",
"longitude": "-43.3615107",
"is_open": null,
"preco": "ND",
"n_reviews": 834,
"rating": 4.4
},
{
"nome": "Transur Transporte Rodoviário Mansur - Escritório Central",
"endereco": "Rua Américo Lôbo, 419 - Manoel Honório, Juiz de Fora",
"latitude": "-21.7438439",
"longitude": "-43.3600568",
"is_open": true,
"preco": "ND",
"n_reviews": 57,
"rating": 3.3,
"detalhes": {
"telefone": "(32) 3249-1800",
"horarios": [
"segunda-feira: 07:30 – 17:30",
"terça-feira: 07:30 – 17:30",
"quarta-feira: 07:30 – 17:30",
"quinta-feira: 07:30 – 17:30",
"sexta-feira: 07:30 – 17:00",
"sábado: Fechado",
"domingo: Fechado"
],
"url_maps": "https://maps.google.com/?cid=7003185105279223490"
}
},
]
}
Busca Web
https://api.economapas.com.br/v2/leads/busca_web
Conforme contratação.
Este endpoint retorna resultados baseado em fontes diversas na Internet de acordo com a localidade definida.
| Campo | Descrição |
|---|---|
| tipo | O tipo de local onde a busca será realizada. Pode ser coords, ponto, cidade ou uf.
Para coords, deverá ser passada uma latitude e longitude válida e de uma localidade permitida em seu usuário. Um raio também pode ser definido (default: 1000 metros); Para ponto, deverá ser passado um id com o id de um de seus pontos definidos no Economapas; Para cidade, deverá ser passada uma cidade no padrão [nome da cidade] - [uf] (ex: Rio de Janeiro - RJ). A cidade deverá ser válida e estar inclusa em seu plano; Para uf, deverá ser passada uma uf válida e disponível no plano, juntamente com a função do economapas visão uf. Obs: o parâmetro considerado será somente os referentes ao que for assinalado no parâmetro tipo. (Ex: caso seja assinalado ponto, somente o parâmetro ponto será considerado e qualquer outro parâmentro será desconsiderado.) |
| latitude | Latitude da coordenada a ser realizada a busca. Obrigatória quando o tipo for coords. |
| longitude | Longitude da coordenada a ser realizada a busca. Obrigatória quando o tipo for coords. |
| id | Id do ponto cadastrado no Economapas onde será realizada a busca. Obrigatória quando o tipo for ponto. |
| cidade | Nome da cidade a ser realizada a busca, necessitando tê-la inclusa em seu plano Economapas. O padrão deverá ser [nome da cidade] - [uf da cidade] (Ex: São Paulo - SP). Obrigatória quando o tipo for cidade. |
| uf | Sigla da uf ser realizada a busca, necessitando tê-la inclusa em seu plano Economapas juntamente com a função visão de estado. Obrigatória quando o tipo for uf. |
| termo | Termo livre (não pode ser vazio) para busca. |
| campos | Apenas os campos especificados na requisição serão retornados e cobrados. Ex.: ["autopeças", "fluxo", "1.01.01_consumo_total"]. Caro queira retornar todos os dados, passe "all" em campos na requisição. Ex.: ["all"]. Obs.: Caso tenha dúvidas sobre quais campos escolher, consulte as rotas equivalentes para a listagem. |
| raio | Raio em metros a partir da coordenada informada. Caso não seja informada no contexto do tipo coords, o padrão será de 1000 metros; |
{
"status": 1,
"content": [
{
"nome": "Feito Perfeito Sucos E Lanches",
"endereco": "Praça Cruz Vermelha, 10, Centro, Rio de Janeiro-RJ, 20230-130",
"latitude": -22.91144,
"longitude": -43.18807,
"preco": "",
"n_reviews": "",
"rating": "",
"detalhes": {
"telefone": "",
"website": ""
},
"fonte": "HERE Maps"
},
{
"nome": "Pizzaria Trigo Mania",
"endereco": "Rua Carlos de Carvalho, Centro, Rio de Janeiro-RJ, 20230-180",
"latitude": -22.91107,
"longitude": -43.18851,
"preco": "",
"n_reviews": "",
"rating": "",
"detalhes": {
"telefone": "+552131812057",
"website": "http://trigomania.com"
},
"fonte": "HERE Maps"
}
]
}
CNPJs
https://api.economapas.com.br/v2/leads/cnpjs
Conforme contratação.
Este endpoint retorna resultados baseado na base de dados de empresas da Receita Federal de acordo com a localidade e os filtros definidos.
| Campo | Descrição |
|---|---|
| tipo | O tipo de local onde a busca será realizada. Pode ser coords, ponto, cidade ou uf.
Para coords, deverá ser passada uma latitude e longitude válida e de uma localidade permitida em seu usuário. Um raio também pode ser definido (default: 1000 metros); Para ponto, deverá ser passado um id com o id de um de seus pontos definidos no Economapas; Para cidade, deverá ser passada uma cidade no padrão [nome da cidade] - [uf] (ex: Rio de Janeiro - RJ). A cidade deverá ser válida e estar inclusa em seu plano; Para uf, deverá ser passada uma uf válida e disponível no plano, juntamente com a função do economapas visão uf. Obs: o parâmetro considerado será somente os referentes ao que for assinalado no parâmetro tipo. (Ex: caso seja assinalado ponto, somente o parâmetro ponto será considerado e qualquer outro parâmentro será desconsiderado.) |
| ponto | Id do ponto onde será realizada a busca. |
| cidade | Nome da cidade a ser realizada a busca. O padrão deverá ser [nome da cidade] - [uf da cidade] (Ex: Belo Horizonte - MG) |
| uf | Sigla da UF a ser realizada a busca. |
| latitude | Latitude da coordenada na qual a busca será realizada. |
| longitude | Longitude da coordenada na qual a busca será realizada. |
| campos | Apenas os campos especificados na requisição serão retornados e cobrados. Ex.: ["autopeças", "fluxo", "1.01.01_consumo_total"]. Caro queira retornar todos os dados, passe "all" em campos na requisição. Ex.: ["all"]. Obs.: Caso tenha dúvidas sobre quais campos escolher, consulte as rotas equivalentes para a listagem. |
| raio | Raio que define região a partir da coordenada passada (latitude e longitude) onde a busca será realizada. Em caso de definição de latitude e longitude sem a definição do raio, o padrão adotado será de 500 metros. |
| cep | Definição de CEP para filtrar resultados. |
| categoria | Categorias de CNAEs pré-definidas para busca. (Veja a tabela de categorias) |
| cnae | Definição de CNAEs para busca. Deverá ser passado o código cnae. Em caso de mais de um cnae para busca, deverão ser passados separados por vírgula. (Ex: 000001, 000002) (Veja a tabela de CNAEs) |
| nome | Busca de empresa por razão social ou nome fantasia. |
| termo | Busca de empresa cuja razão social ou o nome fantasia contenha o termo solicitado. |
| cnpj | Busca de empresa pelo cnpj |
| natureza_juridica | Filtro de busca de empresas cuja natureza juridica seja como a informada. (Veja a tabela de natureza jurídica) |
| porte | Filtro de busca de empresas cujo porte seja como o informado. As possibilidade são: micro, pequeno, medio ou grande. Para todos, passe vazio ou não declare este parâmetro. |
| simples | Filtro de busca de empresas cuja situação no simples seja como a informada. As possibilidades são: indiferente (para qualquer situação), sim, nao ou excluido. Para todos, passe vazio ou não declare este parâmetro. |
| mei | Filtro de busca de empresas que são mei. As possibilidades são: true para mei ou false para os que não são mei. Para todos, passe vazio ou não declare este parâmetro. |
| matriz_filial | Filtro de busca para empresas que são matriz ou filial. As possibilidades são: matriz ou filial. Para ambas, passe vazio ou não declare este parâmetro. |
| capital_social_minimo | Filtro de busca para empresas cujo capital seja maior ou igual ao informado. O valor informado deverá separar centavos por . (Ex: 1000.00 (mil reais)) |
| capital_social_maximo | Filtro de busca para empresas cujo capital seja menor ou igual ao informado. O valor informado deverá separar centavos por . (Ex: 10000.00 (dez mil reais)) |
| data_inicio_minima | Filtro de busca para empresas cuja data de abertura seja igual ou maior à informada. (Padrão: 2021-12-30) |
| data_inicio_maxima | Filtro de busca para empresas cuja data de abertura seja igual ou menor à informada. (Padrão: 2021-12-30) |
| Filtro de busca para empresas cujo e-mail seja o informado | |
| telefone | Filtro de busca para empresas cujo telefone seja o informado |
| nome_socio | Filtro de busca para empresas cujo nome informado pertença a algum sócio. |
| cpf_cnpj_socio | Filtro de busca para empresas cujo cpf/cnpj informado pertença a algum sócio. |
| possui_email | Filtro de busca de empresas que contenham e-mail cadastrado. As possibilidades são: true para filtrar somente empresas que tenham e-mail cadastrado e false para todas. O padrão é false para caso o parâmetro não seja definido. |
| possui_telefone | Filtro de busca de empresas que contenham telefone cadastrado. As possibilidades são: true para filtrar somente empresas que tenham telefone cadastrado e false para todas. O padrão é false para caso o parâmetro não seja definido. |
| possui_celular | Filtro de busca de empresas que contenham telefone cadastrado e que o mesmo seja número de aparelho celular. As possibilidades são: true para filtrar somente empresas que tenham telefone cadastrado e o mesmo pertença a um celular e false para todas. O padrão é false para caso o parâmetro não seja definido. |
| score | Score da empresa. Gera cobrança quando habilitado e retornado. |
| est_faturamento | Indica a estimativa anual de faturamento da empresa. Fonte: ProScore. Gera cobrança quando habilitado e retornado. |
| est_funcionarios | Indica a quantidade estimada de funcionários da empresa. Fonte: ProScore. Gera cobrança quando habilitado e retornado. |
| emails_adicionais | Emails adicionais válidos da empresa. Fonte: BigDataCorp. Gera cobrança quando habilitado e retornado. |
| emails_socios | Emails válidos dos sócios da empresa. Fonte: BigDataCorp. Gera cobrança quando habilitado e retornado. |
| telefones_adicionais | Telefones adicionais da empresa. Fonte: BigDataCorp. Gera cobrança quando habilitado e retornado. |
| site_redes | Indica quais redes sociais a empresa possui. Fonte: BigDataCorp. Gera cobrança quando habilitado e retornado. |
| excludentes | Lista de CNPJs que não deverão ser retornados em sua busca. Para usar, basta passar um vetor com CNPJs excludentes ou então CNPJs em string separados por vírgula. Recomendamos o uso dos CNPJs padronizados, sem caracteres não-numéricos e em lista no formato de vetor (Ex: [012345, 98765, ...]]). Ressaltamos que, caso um CNPJ não esteja corretamente preenchido, o mesmo será descartado. |
| limite | limite de retornos para a busca. O padrão é 100 retornos para casos onde o limite não é informado. Caso o limite passado seja maior que 100, ele será ajustado para 100. Caso o limite passado seja menor que 1, ele será ajustada para 1. |
| pagina | Posição do resultado na paginação da resposta. Por padrão, a resposta informa a página 1. Caso queira os demais resutados, o valor da página pode se incrementado na requisição. O parâmetro proxima_pagina na resposta informa se há mais resultados a serem listados incrementando o valor da página. |
{
"status": 1,
"content": {
"tipo": "lista",
"dados": [
{
"razao_social": "ECONOMAPAS SISTEMAS E TECNOLOGIA LTDA",
"nome_fantasia": "ECONOMAPAS",
"cnpj": "29165327000103",
"cnae": "6209100",
"cnae_str": "6209100 - Suporte técnico, manutenção e outros serviços em tecnologia da informação",
"outros_cnaes": [
"6201501",
"6202300",
"6203100"
],
"outros_cnaes_str": "6201501 - Desenvolvimento de programas de computador sob encomenda;6202300 - Desenvolvimento e licenciamento de programas de computador customizáveis;6203100 - Desenvolvimento e licenciamento de programas de computador não customizáveis",
"uf": "RJ",
"municipio": "RIO DE JANEIRO",
"bairro": "BARRA DA TIJUCA",
"cep": "22631450",
"tipo_logradouro": "RUA",
"logradouro": "JORNALISTA HENRIQUE CORDEIRO",
"numero": "00310",
"latitude": "-23.0048494",
"longitude": "-43.3229128",
"complemento": "APT 805 BLC 1",
"natureza_juridica": "Sociedade Empresária Limitada",
"porte": "Micro",
"matriz_filial": "Matriz",
"simples": "Sim",
"mei": "Não",
"capital_social": "20.000,00",
"data_inicio": "30/10/2017",
"telefone1": "(21) 80650505",
"telefone2": "",
"email": "[email protected]",
"socios": [
{
"nome": "GUSTAVO SOARES FURTADO DE MELO",
"qual_socio": "49",
"cpf_cnpj": "000***672777**"
},
{
"nome": "RAFAEL SALES SOUZA",
"qual_socio": "22",
"cpf_cnpj": "000***013736**"
},
{
"nome": "PATRICK FERRAZ ROCHA GARCIA",
"qual_socio": "22",
"cpf_cnpj": "000***245396**"
}
]
}
],
"pagina": 1,
"limite": 1,
"proxima_pagina": false
}
}
Paginação: O campo proxima_pagina indica se há mais resultados além dos listados no campo dados. Para que você possa paginar a busca, recomenda-se validar o campo para não haja requisições para páginas vazias.
Total de CNPJs
https://api.economapas.com.br/v2/leads/cnpjs/total
Conforme contratação.
Este endpoint retorna a quantidade de empresas baseado nas empresas regularmente cadastradas na Receita Federal de acordo com a localidade e os filtros definidos.
| Campo | Descrição |
|---|---|
| tipo | O tipo de local onde a busca será realizada. Pode ser coords, ponto, cidade ou uf.
Para coords, deverá ser passada uma latitude e longitude válida e de uma localidade permitida em seu usuário. Um raio também pode ser definido (default: 1000 metros); Para ponto, deverá ser passado um id com o id de um de seus pontos definidos no Economapas; Para cidade, deverá ser passada uma cidade no padrão [nome da cidade] - [uf] (ex: Rio de Janeiro - RJ). A cidade deverá ser válida e estar inclusa em seu plano; Para uf, deverá ser passada uma uf válida e disponível no plano, juntamente com a função do economapas visão uf. Obs: o parâmetro considerado será somente os referentes ao que for assinalado no parâmetro tipo. (Ex: caso seja assinalado ponto, somente o parâmetro ponto será considerado e qualquer outro parâmentro será desconsiderado.) |
| ponto | Id do ponto onde será realizada a busca. |
| cidade | Nome da cidade a ser realizada a busca. O padrão deverá ser [nome da cidade] - [uf da cidade] (Ex: Belo Horizonte - MG) |
| uf | Sigla da UF a ser realizada a busca. |
| latitude | Latitude da coordenada na qual a busca será realizada. |
| longitude | Longitude da coordenada na qual a busca será realizada. |
| campos | Apenas os campos especificados na requisição serão retornados e cobrados. Ex.: ["autopeças", "fluxo", "1.01.01_consumo_total"]. Caro queira retornar todos os dados, passe "all" em campos na requisição. Ex.: ["all"]. Obs.: Caso tenha dúvidas sobre quais campos escolher, consulte as rotas equivalentes para a listagem. |
| raio | Raio que define região a partir da coordenada passada (latitude e longitude) onde a busca será realizada. Em caso de definição de latitude e longitude sem a definição do raio, o padrão adotado será de 500 metros. |
| cep | Definição de CEP para filtrar resultados. |
| categoria | Categorias de CNAEs pré-definidas para busca. (Veja a tabela de categorias) |
| cnae | Definição de CNAEs para busca. Deverá ser passado o código cnae. Em caso de mais de um cnae para busca, deverão ser passados separados por vírgula. (Ex: 000001, 000002) (Veja a tabela de CNAEs) |
| nome | Busca de empresa por razão social ou nome fantasia. |
| termo | Busca de empresa cuja razão social ou o nome fantasia contenha o termo solicitado. |
| cnpj | Busca de empresa pelo cnpj |
| natureza_juridica | Filtro de busca de empresas cuja natureza juridica seja como a informada. (Veja a tabela de natureza jurídica) |
| porte | Filtro de busca de empresas cujo porte seja como o informado. As possibilidade são: micro, pequeno, medio ou grande. Para todos, passe vazio ou não declare este parâmetro. |
| simples | Filtro de busca de empresas cuja situação no simples seja como a informada. As possibilidades são: indiferente (para qualquer situação), sim, nao ou excluido. Para todos, passe vazio ou não declare este parâmetro. |
| mei | Filtro de busca de empresas que são mei. As possibilidades são: true para mei ou false para os que não são mei. Para todos, passe vazio ou não declare este parâmetro. |
| matriz_filial | Filtro de busca para empresas que são matriz ou filial. As possibilidades são: matriz ou filial. Para ambas, passe vazio ou não declare este parâmetro. |
| capital_social_minimo | Filtro de busca para empresas cujo capital seja maior ou igual ao informado. O valor informado deverá separar centavos por . (Ex: 1000.00 (mil reais)) |
| capital_social_maximo | Filtro de busca para empresas cujo capital seja menor ou igual ao informado. O valor informado deverá separar centavos por . (Ex: 10000.00 (dez mil reais)) |
| data_inicio_minima | Filtro de busca para empresas cuja data de abertura seja igual ou maior à informada. (Padrão: 2021-12-30) |
| data_inicio_maxima | Filtro de busca para empresas cuja data de abertura seja igual ou menor à informada. (Padrão: 2021-12-30) |
| Filtro de busca para empresas cujo e-mail seja o informado | |
| telefone | Filtro de busca para empresas cujo telefone seja o informado |
| nome_socio | Filtro de busca para empresas cujo nome informado pertença a algum sócio. |
| cpf_cnpj_socio | Filtro de busca para empresas cujo cpf/cnpj informado pertença a algum sócio. |
| possui_email | Filtro de busca de empresas que contenham e-mail cadastrado. As possibilidades são: true para filtrar somente empresas que tenham e-mail cadastrado e false para todas. O padrão é false para caso o parâmetro não seja definido. |
| possui_telefone | Filtro de busca de empresas que contenham telefone cadastrado. As possibilidades são: true para filtrar somente empresas que tenham telefone cadastrado e false para todas. O padrão é false para caso o parâmetro não seja definido. |
| possui_celular | Filtro de busca de empresas que contenham telefone cadastrado e que o mesmo seja número de aparelho celular. As possibilidades são: true para filtrar somente empresas que tenham telefone cadastrado e o mesmo pertença a um celular e false para todas. O padrão é false para caso o parâmetro não seja definido. |
| excludentes | Lista de CNPJs que não deverão ser retornados em sua busca. Para usar, basta passar um vetor com CNPJs excludentes ou então CNPJs em string separados por vírgula. Recomendamos o uso dos CNPJs padronizados, sem caracteres não-numéricos e em lista no formato de vetor (Ex: [012345, 98765, ...]]). Ressaltamos que, caso um CNPJ não esteja corretamente preenchido, o mesmo será descartado. |
{
"status": 1,
"content": {
"total": "183"
}
}
Imobiliário
Com os endpoints imobiliários você poderá consultar imóveis de acordo com critérios adotados via API.
Consulta - Campos Disponíveis
https://api.economapas.com.br/v2/imob/campos
Gratuito.
| Não há parâmetros necessários nessa requisição. |
{
"status": 1,
"content": {
"campos_disponiveis": [
"lat",
"lng",
"titulo",
"area",
"preco",
"valorcondominio"
]
}
}
Consulta
https://api.economapas.com.br/v2/imob
Conforme contratação.
| Campo | Descrição |
|---|---|
| tipo | O tipo de local onde a busca será realizada. Pode ser coords, ponto, cidade ou uf.
Para coords, deverá ser passada uma latitude e longitude válida e de uma localidade permitida em seu usuário. Um raio também pode ser definido (default: 1000 metros); Para ponto, deverá ser passado um id com o id de um de seus pontos definidos no Economapas; Para cidade, deverá ser passada uma cidade no padrão [nome da cidade] - [uf] (ex: Rio de Janeiro - RJ). A cidade deverá ser válida e estar inclusa em seu plano; Para uf, deverá ser passada uma uf válida e disponível no plano, juntamente com a função do economapas visão uf. Obs: o parâmetro considerado será somente os referentes ao que for assinalado no parâmetro tipo. (Ex: caso seja assinalado ponto, somente o parâmetro ponto será considerado e qualquer outro parâmentro será desconsiderado.) |
| latitude | Latitude da coordenada do local onde a busca será realizada. |
| longitude | Longitude da coordenada do local onde a busca será realizada. |
| cidade | Cidade onde será feita a busca. |
| id | Id do ponto que será feita a busca |
| categoria | Modalidade do anuncio. Pode ser COMPRA ou ALUGUEL |
| subcategoria | Tipo do local. (Veja as subcategorias) |
| campos | Apenas os campos especificados na requisição serão retornados e cobrados. Ex.: ["autopeças", "fluxo", "1.01.01_consumo_total"]. Caro queira retornar todos os dados, passe "all" em campos na requisição. Ex.: ["all"]. Obs.: Caso tenha dúvidas sobre quais campos escolher, consulte as rotas equivalentes para a listagem. |
| raio | Raio a partir da latitude e longitude do local onde a busca será realizada. Caso não seja declarado, será adotado o raio padrão de 1000 metros. |
| preco_min | Filtro de preço mínimo para os resultados. |
| preco_max | Filtro de preço máximo para os resultados. |
| quartos_min | Filtro de quantidade mínima de quartos para os resultados. |
| quartos_max | Filtro de quantidade máxima de quartos para os resultados. |
| area_min | Filtro de área mínima para os resultados. |
| area_max | Filtro de área máxima para os resultados. |
| limite | limite de retornos para a busca. O padrão é 50 retornos para casos onde o limite não é informado. O número de resultados máximo é de 100 resultados. Caso o limite passado seja maior que 100 ou menor que 1, ele será ajustado para o padrão. |
| pagina | Posição do resultado na paginação da resposta. Por padrão, a resposta informa a página 1. Caso queira os demais resutados, o valor da página pode se incrementado na requisição. O parâmetro proxima_pagina na resposta informa se há mais resultados a serem listados incrementando o valor da página. |
{
"status": 1,
"content": {
"dados": [
{
"lat": "-23.52951880",
"lng": "-46.65648360",
"titulo": "Barra Funda",
"area": 0,
"preco": "615.000,00",
"valorcondominio": "500,00",
"preco_m2": "0,00",
"fonte": "VivaReal",
"responsavel": "COLONHESE INCORPORADORA E EMPREENDIMENTOS IMOBILIARIOS LTDA - ME",
"quartos": "2",
"garagens": "1",
"caracteristicas": "",
"url": [link],
"id": "563",
"subcategoria": "APARTAMENTO"
}
],
"proxima_pagina": true
}
}
Em caso de dúvidas e/ou imprevistos, contate o [email protected].