Saltar al contenido principal
placeanalyzerAPI ReferenceGuías

Análisis Comercial

Comprende el entorno comercial que rodea a una propiedad. Esta colección de endpoints te permite obtener desde un resumen rápido de los comercios más cercanos hasta un análisis detallado filtrado por categorías o sectores.

Resumen de Endpoints

EndpointDescripciónVariantes
/near-commercesComercios más cercanosPor coordenadas, por requestCode
/commercial-activityTodos los comercios en la zonaPor coordenadas, por requestCode, GeoJSON
/categoryComercios por categoría específicaPor coordenadas, por requestCode
/sectorComercios por sector/rubroPor coordenadas, por requestCode
/commerce-graphicDatos para gráficos de actividadPor coordenadas, por requestCode
/sector-graphicDatos para gráficos por sectorPor coordenadas, por requestCode

Comercios Cercanos

Retorna los comercios más cercanos a la ubicación, agrupados por tipo. Ideal para una vista rápida de "lo que hay cerca" de la propiedad.

Respuesta: Objeto con arrays de CommercesDto agrupados por tipo de comercio.

Por coordenadas

Parámetros requeridos: region, lat, lng

getNearCommerces

GET 

/near-commerces

getNearCommerces

Request​

Responses​

OK

Por requestCode

Usa el código de un avalúo existente para obtener los comercios cercanos a esa propiedad.

getNearCommercesByRequestCode

GET 

/near-commerces/:requestCode

getNearCommercesByRequestCode

Request​

Responses​

OK


Actividad Comercial

Retorna todos los comercios en un radio desde la ubicación. Es el endpoint principal para analizar la actividad comercial total de la zona.

Respuesta: Array de CommercesDto con todos los comercios encontrados.

Por coordenadas

Parámetros requeridos: region, lat, lng

getCommercesActivity

GET 

/commercial-activity

getCommercesActivity

Request​

Responses​

OK

Por requestCode

getCommercesActivityByRequestCode

GET 

/commercial-activity/:requestCode

getCommercesActivityByRequestCode

Request​

Responses​

OK

Formato GeoJSON

Retorna los datos en formato GeoJSON para visualización en mapas.

getCommercesActivityGeoJson

GET 

/commercial-activity-geojson

getCommercesActivityGeoJson

Request​

Responses​

OK


Comercios por Categoría

Retorna comercios filtrados por una categoría específica (ej. "restaurantes", "bebidas", "helados").

Parámetros adicionales: category (string) - La categoría a filtrar

Respuesta: Array de CommercesDto de la categoría especificada.

Por coordenadas

Parámetros requeridos: region, category, lat, lng

getCommercesByCategory

GET 

/category

getCommercesByCategory

Request​

Responses​

OK

Por requestCode

getCommercesByCategory_1

GET 

/category/:requestCode

getCommercesByCategory_1

Request​

Responses​

OK


Comercios por Sector

Retorna comercios filtrados por sector o rubro específico (ej. "Construcción", "Educación", "Servicios varios").

Parámetros adicionales: sector (string) - El sector/rubro a filtrar

Respuesta: Array de CommercesDto del sector especificado.

Por coordenadas

Parámetros requeridos: region, sector, lat, lng

getCommercesBySector

GET 

/sector

getCommercesBySector

Request​

Responses​

OK

Por requestCode

getCommercesBySectorAndRequestCode

GET 

/sector/:requestCode

getCommercesBySectorAndRequestCode

Request​

Responses​

OK


Gráficos de Actividad Comercial

Retorna datos agregados para construir gráficos de barras o torta sobre la distribución de comercios.

Respuesta: Array de CommerceGraphicDto con name (tipo de comercio) y probability (porcentaje).

Por coordenadas

Parámetros requeridos: region, lat, lng

getCommercesGraphic

GET 

/commerce-graphic

getCommercesGraphic

Request​

Responses​

OK

Por requestCode

getCommercesGraphic_1

GET 

/commerce-graphic/:requestCode

getCommercesGraphic_1

Request​

Responses​

OK


Gráficos por Sector

Similar al gráfico de actividad, pero agrupa los comercios por sector/rubro.

Parámetros adicionales: sector (string) - El sector a analizar

Respuesta: Array de CommerceGraphicDto con distribución por sector.

Por coordenadas

Parámetros requeridos: region, sector, lat, lng

getCommercesSectorGraphic

GET 

/sector-graphic

getCommercesSectorGraphic

Request​

Responses​

OK

Por requestCode

getCommercesSectorGraphicByRequestCode

GET 

/sector-graphic/:requestCode

getCommercesSectorGraphicByRequestCode

Request​

Responses​

OK


Modelo de Datos

CommercesDto

CampoTipoDescripción
namestringNombre del comercio
phonestringTeléfono de contacto
categorystringCategoría del comercio
sectorstringSector/rubro del comercio
iconstringURL del icono
imgstringURL de la imagen
latnumberLatitud del comercio
lngnumberLongitud del comercio

CommerceGraphicDto

CampoTipoDescripción
namestringNombre del tipo/categoría
probabilityintegerPorcentaje o cantidad

API Reference

Comercios cercanos

GET

Comercios cercanos (requestCode)

GET

Actividad comercial

GET

Actividad comercial (requestCode)

GET

Actividad comercial GeoJSON

GET

Por categoría

GET

Por categoría (requestCode)

GET

Por sector

GET

Por sector (requestCode)

GET

Gráfico de actividad

GET

Gráfico actividad (requestCode)

GET

Gráfico por sector

GET

Gráfico sector (requestCode)

GET