Pular para o conteúdo principal

Endpoint de Estatísticas

POST /samples_statistics

Base URL: https://api.prd.valuation.eemovel.com.br/valuation/adsky/internal

Endpoint responsável por buscar estatísticas de amostras de imóveis.

Headers

ParâmetroTipoObrigatórioDescrição
roleidstringSimID da role para autenticação (ex: 1dcedd1737b59b57d54892985ce6e78c)
x-api-keystringSimChave de autenticação única fornecida pelo suporte

Body

O body deve seguir o schema SearchSamplesPayload com os seguintes parâmetros opcionais:

ParâmetroTipoPadrãoDescrição
paginate_frominteger0Ponto de início da paginação (não aplicável para estatísticas)
property_typearray[integer]-Tipos de propriedade
business_typestring-Tipo de negócio (ex: "sale", "rent")
min_pricenumber-Preço mínimo
max_pricenumber-Preço máximo
min_sqrmeter_pricenumber-Preço mínimo por metro quadrado
max_sqrmeter_pricenumber-Preço máximo por metro quadrado
min_areanumber-Área mínima
max_areanumber-Área máxima
min_total_areanumber-Área total mínima
max_total_areanumber-Área total máxima
activeboolean-Se está ativo
latnumber-Latitude
lonnumber-Longitude
distancenumber500Distância em metros
polygonstring-Polígono de busca
address_qualityarray[integer]-Qualidade do endereço
bedroomsarray[integer]-Número de quartos
bathroomsarray[integer]-Número de banheiros
suitesarray[integer]-Número de suítes
garagesarray[integer]-Número de garagens
min_ageinteger-Idade mínima do anúncio em dias
max_ageinteger-Idade máxima do anúncio em dias
reference_realtyobject-Imóvel de referência
sort_bystring"area"Campo para ordenação (area, features_bedroom, feature_garage, age, transaction_sale, transaction_rent, similarity_index, sqrmeter_price_area_sale, sqrmeter_price_area_rent, features_suite, features_bathroom)
orderstring"desc"Direção da ordenação (asc ou desc)
addressstring-Endereço do imóvel

Imóvel de Referência (reference_realty)

ParâmetroTipoObrigatórioDescrição
latnumberSimLatitude do imóvel de referência
lonnumberSimLongitude do imóvel de referência
streetstringNãoRua do imóvel de referência
numberstringNãoNúmero do imóvel de referência
areanumberNãoÁrea do imóvel de referência
bedroomsintegerNãoNúmero de quartos
suitesintegerNãoNúmero de suítes
garagesintegerNãoNúmero de garagens
bathroomsintegerNãoNúmero de banheiros
property_typestringNãoTipo de imóvel (Apartamento ou Casa)

Resposta

Status Code: 200

Descrição: Sucesso - retorna as estatísticas das amostras encontradas

Estrutura da Resposta

{
"pins": [
{
"realty_id": "string",
"location_point": [longitude, latitude],
"age": integer,
"transaction_sale": number,
"transaction_rent": number,
"ad_count": integer
}
],
"total_samples": integer,
"avg_sqr_meter_price_sale": "string",
"avg_sqr_meter_price_rent": "string",
"avg_price_sale": "string",
"avg_price_rent": "string"
}

Campos da Resposta

CampoTipoDescrição
pinsarrayLista de imóveis encontrados
pins[].realty_idstringID único do imóvel
pins[].location_pointarray[number]Coordenadas [longitude, latitude]
pins[].ageintegerIdade do anúncio em dias
pins[].transaction_salenumberValor de venda do imóvel
pins[].transaction_rentnumberValor de aluguel do imóvel
pins[].ad_countintegerQuantidade de anúncios deste imóvel
total_samplesintegerTotal de amostras encontradas
avg_sqr_meter_price_salestringPreço médio por m² para venda (formatado)
avg_sqr_meter_price_rentstringPreço médio por m² para aluguel (formatado)
avg_price_salestringPreço médio de venda (formatado)
avg_price_rentstringPreço médio de aluguel (formatado)

Exemplo de uso

curl -X POST https://api.prd.valuation.eemovel.com.br/valuation/adsky/internal/samples_statistics \
-H "Content-Type: application/json" \
-H "roleid: 1dcedd1737b59b57d54892985ce6e78c" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"lat": -23.5505,
"lon": -46.6333,
"distance": 1000,
"property_type": [1, 2],
"min_area": 50,
"max_area": 200,
"reference_realty": {
"lat": -23.5505,
"lon": -46.6333,
"area": 80,
"bedrooms": 2,
"property_type": "Apartamento"
}
}'