Skip to main content

Nuevo Reporte

Crea un nuevo reporte para un inmueble con las características especificadas.

Modo de Pruebas

Si el reporte no es generado en modo de pruebas, será descontado de los reportes disponibles.

Verificar Disponibilidad

Antes de crear un nuevo reporte puedes revisar si se podrá generar el reporte usando el endpoint query-available.

POSThttps://api.finco.co/v1/new-query

Request Body (JSON)#

KeyTipo y CondicionesRequeridoDescripción
APIKeystring
60 caractéres
Key de accesso a la API
testboolean
Default = false
Activa el modo de pruebas
testErrorQueryError
Código de error a simular
makePublicboolean
Si el valor es true el reporte se generará público (cualquier usuario podrá acceder a este a través de la url). De lo contrario será privado y solo podrá ser vista dentro de finco.co por la cuenta que lo generó
propertyTypePropertyTypeEnum
Tipo de propiedad que se desea consultar
addressstring
Dirección del inmueble. Aparecerá dentro del reporte
locationobject
Contiene las coordenadas del inmueble que se está consultado
location > latitudefloat
Latitud de las coordenadas en grados
location > longitudefloat
Longitud de las coordenadas en grados
queryQuery
Características del inmueble. Revisar requerimientos específicos para cada ciudad y tipo de inmueble

Response Body (JSON)#

KeyTipoDescripción
urlstring
URL a finco.co del reporte generado
publicboolean
Indica si el reporte se generó público
paidboolean
true si el reporte generado cuenta con información real y fue descontado de los reportes disponibles
testingboolean
Indica si el reporte fue generado en modo de pruebas
idstring
Id del reporte
generationTimefloat
Tiempo en ms de respuesta del modelo
resultQueryResult
Resultados y estadísticas. La estructura y disponibilidad de estos pueden variar según la ciudad en que se genere el reporte y el tipo de inmueble

Ejemplo#

Request Body (JSON)#

{
"APIKey": "{{APIKey}}",
"test": true,
"makePublic": true,
"propertyType": "APARTMENT",
"location": {
"latitude": 19.3757956,
"longitude": -99.1486069
},
// Características del inmbueble.
// Los campos requeridos varían según el país y tipo de inmueble
"query": {...}
}

Response Body (JSON)#

Status:200OK
{
"query": {
"url": "https://www.finco.co/report/7b6747be-41ea-44d1-91ec-518ca3f0a66c",
"public": true,
"paid": false,
"testing": true,
"id": "7b6747be-41ea-44d1-91ec-518ca3f0a66c",
"generationTime": 50,
"result": {...}
}
}

Ejemplo Reporte No Disponible#

Request Body (JSON)#

{
"APIKey": "{{APIKey}}",
"test": true,
"testError": "QUERY_NOT_ALLOWED",
"makePublic": true,
"propertyType": "APARTMENT",
"location": {
"latitude": 19.3757956,
"longitude": -99.1486069
},
// Características del inmbueble.
// Los campos requeridos varían según el país y tipo de inmueble
"query": {...}
}

Response Body (JSON)#

Status:422Unprocessable Entity
{
"error": {
"code": "QUERY_NOT_ALLOWED",
"message": "No es posible generar el reporte para estas coordenadas"
}
}

Ejemplo Reportes Insuficientes#

Request Body (JSON)#

{
"APIKey": "{{APIKey}}",
"test": true,
"testError": "INSUFFICIENT_QUERIES",
"makePublic": true,
"propertyType": "APARTMENT",
"location": {
"latitude": 19.3757956,
"longitude": -99.1486069
},
// Características del inmbueble.
// Los campos requeridos varían según el país y tipo de inmueble
"query": {...}
}

Response Body (JSON)#

Status:402Payment Required
{
"error": {
"code": "INSUFFICIENT_QUERIES",
"message": "No cuentas con reportes disponibles"
}
}