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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| roleid | string | Sim | ID da role para autenticação (ex: 1dcedd1737b59b57d54892985ce6e78c) |
| x-api-key | string | Sim | Chave de autenticação única fornecida pelo suporte |
Body
O body deve seguir o schema SearchSamplesPayload com os seguintes parâmetros opcionais:
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
| paginate_from | integer | 0 | Ponto de início da paginação (não aplicável para estatísticas) |
| property_type | array[integer] | - | Tipos de propriedade |
| business_type | string | - | Tipo de negócio (ex: "sale", "rent") |
| min_price | number | - | Preço mínimo |
| max_price | number | - | Preço máximo |
| min_sqrmeter_price | number | - | Preço mínimo por metro quadrado |
| max_sqrmeter_price | number | - | Preço máximo por metro quadrado |
| min_area | number | - | Área mínima |
| max_area | number | - | Área máxima |
| min_total_area | number | - | Área total mínima |
| max_total_area | number | - | Área total máxima |
| active | boolean | - | Se está ativo |
| lat | number | - | Latitude |
| lon | number | - | Longitude |
| distance | number | 500 | Distância em metros |
| polygon | string | - | Polígono de busca |
| address_quality | array[integer] | - | Qualidade do endereço |
| bedrooms | array[integer] | - | Número de quartos |
| bathrooms | array[integer] | - | Número de banheiros |
| suites | array[integer] | - | Número de suítes |
| garages | array[integer] | - | Número de garagens |
| min_age | integer | - | Idade mínima do anúncio em dias |
| max_age | integer | - | Idade máxima do anúncio em dias |
| reference_realty | object | - | Imóvel de referência |
| sort_by | string | "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) |
| order | string | "desc" | Direção da ordenação (asc ou desc) |
| address | string | - | Endereço do imóvel |
Imóvel de Referência (reference_realty)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| lat | number | Sim | Latitude do imóvel de referência |
| lon | number | Sim | Longitude do imóvel de referência |
| street | string | Não | Rua do imóvel de referência |
| number | string | Não | Número do imóvel de referência |
| area | number | Não | Área do imóvel de referência |
| bedrooms | integer | Não | Número de quartos |
| suites | integer | Não | Número de suítes |
| garages | integer | Não | Número de garagens |
| bathrooms | integer | Não | Número de banheiros |
| property_type | string | Não | Tipo 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
| Campo | Tipo | Descrição |
|---|---|---|
| pins | array | Lista de imóveis encontrados |
| pins[].realty_id | string | ID único do imóvel |
| pins[].location_point | array[number] | Coordenadas [longitude, latitude] |
| pins[].age | integer | Idade do anúncio em dias |
| pins[].transaction_sale | number | Valor de venda do imóvel |
| pins[].transaction_rent | number | Valor de aluguel do imóvel |
| pins[].ad_count | integer | Quantidade de anúncios deste imóvel |
| total_samples | integer | Total de amostras encontradas |
| avg_sqr_meter_price_sale | string | Preço médio por m² para venda (formatado) |
| avg_sqr_meter_price_rent | string | Preço médio por m² para aluguel (formatado) |
| avg_price_sale | string | Preço médio de venda (formatado) |
| avg_price_rent | string | Preç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"
}
}'