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)#

Key	Tipo y Condiciones	Requerido	Descripción
APIKey	string 60 caractéres		Key de accesso a la API
test	boolean	Default = false	Activa el modo de pruebas
testError	QueryError		Código de error a simular
makePublic	boolean		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ó
propertyType	PropertyTypeEnum		Tipo de propiedad que se desea consultar
address	string		Dirección del inmueble. Aparecerá dentro del reporte
location	object		Contiene las coordenadas del inmueble que se está consultado
location > latitude	float		Latitud de las coordenadas en grados
location > longitude	float		Longitud de las coordenadas en grados
query	Query		Características del inmueble. Revisar requerimientos específicos para cada ciudad y tipo de inmueble

Response Body (JSON)#

Key	Tipo	Descripción
url	string	URL del reporte generado
public	boolean	Indica si el reporte se generó público
paid	boolean	true si el reporte generado cuenta con información real y fue descontado de los reportes disponibles
testing	boolean	Indica si el reporte fue generado en modo de pruebas
id	string	Id del reporte
generationTime	float	Tiempo en ms de respuesta del modelo
result	QueryResult	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"
  }
}