Skip to main content
POST
/quintoandar/properties/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
business_context
enum<string>
default:RENT
Available options:
RENT,
SALE
price_min
integer | null
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
price_type
enum<string> | null
Available options:
RENT_PRICE,
TOTAL_COST,
SALE_PRICE
house_type
enum<string>[] | null
Available options:
APARTMENT,
HOUSE,
HOUSE_CONDO,
STUDIO
area_min
integer | null
Required range: x >= 0
area_max
integer | null
Required range: x >= 0
bedrooms_min
integer | null
Required range: x >= 1
bathrooms_min
integer | null
Required range: x >= 1
parking_min
integer | null
Required range: x >= 1
suites_min
integer | null
Required range: x >= 1
furnished
boolean | null
accepts_pets
boolean | null
near_subway
boolean | null
availability
enum<string>
default:ANY
Available options:
ANY,
immediate,
soon
amenities
enum<string>[] | null
Available options:
APARTAMENTO_COBERTURA,
AR_CONDICIONADO,
BANHEIRA_DE_HIDROMASSAGEM,
BOX,
CHURRASQUEIRA,
CHUVEIRO_A_GAS,
CLOSET,
NOVOS_OU_REFORMADOS,
PISCINA_PRIVATIVA,
SOMENTE_UMA_CASA_NO_TERRENO,
TANQUE,
TELEVISAO,
UTENSILIOS_DE_COZINHA,
VENTILADOR_DE_TETO,
GARDEN,
ARMARIOS_NA_COZINHA,
ARMARIOS_EMBUTIDOS_NO_QUARTO,
ARMARIOS_NOS_BANHEIROS,
CAMA_DE_CASAL,
CAMA_DE_SOLTEIRO,
MESAS_E_CADEIRAS_DE_JANTAR,
SOFA,
LUMINOSIDADE_NATURAL,
RUA_SILENCIOSA,
SOL_DA_MANHA,
SOL_DA_TARDE,
VISTA_LIVRE,
FOGAO_INCLUSO,
COOKTOP,
GELADEIRA_INCLUSO,
MICROONDAS,
MAQUINA_DE_LAVAR,
AREA_DE_SERVICO,
COZINHA_AMERICANA,
MESAS_E_CADEIRAS_DE_ESCRITORIO,
JARDIM,
QUINTAL,
VARANDA
installations
enum<string>[] | null
Available options:
ACADEMIA,
AREA_VERDE,
BRINQUEDOTECA,
CHURRASQUEIRA,
Elevador,
LAVANDERIA_NO_PREDIO,
PISCINA,
PLAYGROUND,
Porteiro24H,
QUADRA_ESPORTIVA,
SALAO_DE_FESTAS,
SALAO_DE_JOGOS,
SAUNA
accessibility
enum<string>[] | null
Available options:
BANHEIRO_ADAPTADO,
CORRIMAO,
PISO_TATIL,
QUARTOS_E_CORREDORES_COM_PORTAS_AMPLAS,
RAMPAS_DE_ACESSO,
VAGA_DE_GARAGEM_ACESSIVEL
sort_by
enum<string>
default:RELEVANCE
Available options:
RELEVANCE,
TOTAL_COST,
SALE_PRICE,
RENT_VALUE
sort_order
enum<string>
default:DESC
Available options:
ASC,
DESC

Response

Successful Response

id
string
required
url
string
required
@type
string
default:QuintoandarListing
house_type
string | null
address
string | null
neighbourhood
string | null
region_name
string | null
city
string | null
latitude
number | null
longitude
number | null
rent_value
number | null
sale_price
number | null
total_cost
number | null
condominium
number | null
iptu_plus_condominium
number | null
area
number | null
bedroom_count
integer | null
bathroom_count
integer | null
suite_count
integer | null
parking_count
integer | null
is_furnished
boolean | null
has_elevator
boolean | null
for_rent
boolean | null
for_sale
boolean | null
visit_status
string | null
yield_rate
number | null
listing_tags
string[]
special_conditions
string[]
amenities
string[]
installations
string[]
accessibility
string[]
image
string | null
images
string[]