/quintoandar/properties/search

curl --request POST \
  --url https://api.anysite.io/api/quintoandar/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "location": "<string>",
  "count": 2,
  "timeout": 300,
  "business_context": "RENT",
  "price_min": 1,
  "price_max": 1,
  "house_type": [],
  "area_min": 1,
  "area_max": 1,
  "bedrooms_min": 2,
  "bathrooms_min": 2,
  "parking_min": 2,
  "suites_min": 2,
  "furnished": true,
  "accepts_pets": true,
  "near_subway": true,
  "availability": "ANY",
  "amenities": [],
  "installations": [],
  "accessibility": [],
  "sort_by": "RELEVANCE",
  "sort_order": "DESC"
}
'

[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@quintoandar_listing",
    "house_type": "<string>",
    "address": "<string>",
    "neighbourhood": "<string>",
    "region_name": "<string>",
    "city": "<string>",
    "latitude": 123,
    "longitude": 123,
    "rent_value": 123,
    "sale_price": 123,
    "total_cost": 123,
    "condominium": 123,
    "iptu_plus_condominium": 123,
    "area": 123,
    "bedroom_count": 123,
    "bathroom_count": 123,
    "suite_count": 123,
    "parking_count": 123,
    "is_furnished": true,
    "has_elevator": true,
    "for_rent": true,
    "for_sale": true,
    "visit_status": "<string>",
    "yield_rate": 123,
    "listing_tags": [],
    "special_conditions": [],
    "amenities": [],
    "installations": [],
    "accessibility": [],
    "image": "<string>",
    "images": []
  }
]

/quintoandar

/quintoandar/properties/search

Search QuintoAndar real-estate listings in a Brazilian city by location slug with rent or sale context and a full set of filters (price range, property type, area range, bedrooms, bathrooms, parking, suites, furnished, pets, near subway, availability, amenities, building installations, accessibility, sort). Returns listings with address, neighbourhood and coordinates, rent and sale price, total cost, area, bedrooms, bathrooms, suites, parking, amenities, installations, accessibility features, listing tags, images and visit status.

Price: 1 credit

💡 AI Hint: Search QuintoAndar listings in a city (location=‘sao-paulo-sp-brasil’, business_context=RENT or SALE). Optional filters: price_min/price_max (with optional price_type), house_type, area_min/max, bedrooms_min, bathrooms_min, parking_min, suites_min, furnished, accepts_pets, near_subway, availability, amenities, installations, accessibility, sort_by, sort_order. Each item has id, url, address, neighbourhood, city, latitude/longitude, rent_value, sale_price, total_cost, area, bedroom_count, bathroom_count, suite_count, parking_count, amenities, installations, accessibility, listing_tags, image and images.

⚠️ Common errors: 412: No matching city/location found for the given slug

POST

api

quintoandar

properties

/quintoandar/properties/search

curl --request POST \
  --url https://api.anysite.io/api/quintoandar/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "location": "<string>",
  "count": 2,
  "timeout": 300,
  "business_context": "RENT",
  "price_min": 1,
  "price_max": 1,
  "house_type": [],
  "area_min": 1,
  "area_max": 1,
  "bedrooms_min": 2,
  "bathrooms_min": 2,
  "parking_min": 2,
  "suites_min": 2,
  "furnished": true,
  "accepts_pets": true,
  "near_subway": true,
  "availability": "ANY",
  "amenities": [],
  "installations": [],
  "accessibility": [],
  "sort_by": "RELEVANCE",
  "sort_order": "DESC"
}
'

[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@quintoandar_listing",
    "house_type": "<string>",
    "address": "<string>",
    "neighbourhood": "<string>",
    "region_name": "<string>",
    "city": "<string>",
    "latitude": 123,
    "longitude": 123,
    "rent_value": 123,
    "sale_price": 123,
    "total_cost": 123,
    "condominium": 123,
    "iptu_plus_condominium": 123,
    "area": 123,
    "bedroom_count": 123,
    "bathroom_count": 123,
    "suite_count": 123,
    "parking_count": 123,
    "is_furnished": true,
    "has_elevator": true,
    "for_rent": true,
    "for_sale": true,
    "visit_status": "<string>",
    "yield_rate": 123,
    "listing_tags": [],
    "special_conditions": [],
    "amenities": [],
    "installations": [],
    "accessibility": [],
    "image": "<string>",
    "images": []
  }
]

Authorizations

access-token

string

header

required

API token from the dashboard

Headers

access-token

string

required

Body

application/json

location

string

required

City slug, e.g. 'sao-paulo-sp-brasil' or 'rio-de-janeiro-rj-brasil'

Minimum string length: 1

Example:

"sao-paulo-sp-brasil"

count

integer

required

Max number of listings to return

Required range: x >= 1

timeout

integer

default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

business_context

enum<string>

default:RENT

Rent or sale listings

Available options:

RENT,

SALE

price_min

integer | null

Minimum price in BRL

Required range: x >= 0

price_max

integer | null

Maximum price in BRL

Required range: x >= 0

price_type

enum<string> | null

Which price the price_min/price_max range applies to. Defaults to monthly rent for rent listings and sale price for sale listings

Available options:

RENT_PRICE,

TOTAL_COST,

SALE_PRICE

house_type

enum<string>[] | null

Property type filter

Available options:

APARTMENT,

HOUSE,

HOUSE_CONDO,

STUDIO

area_min

integer | null

Minimum floor area in m2

Required range: x >= 0

area_max

integer | null

Maximum floor area in m2

Required range: x >= 0

bedrooms_min

integer | null

Minimum number of bedrooms

Required range: x >= 1

bathrooms_min

integer | null

Minimum number of bathrooms

Required range: x >= 1

parking_min

integer | null

Minimum number of parking spaces

Required range: x >= 1

suites_min

integer | null

Minimum number of suites

Required range: x >= 1

furnished

boolean | null

Only furnished or only unfurnished listings

accepts_pets

boolean | null

Only listings that accept pets

near_subway

boolean | null

Only listings near a subway or train station

availability

enum<string>

default:ANY

Availability filter

Available options:

ANY,

immediate,

soon

amenities

enum<string>[] | null

Required unit amenities

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

Required building installations

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

Required accessibility features

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

Sort criteria

Available options:

RELEVANCE,

TOTAL_COST,

SALE_PRICE,

RENT_VALUE

sort_order

enum<string>

default:DESC

Sort direction

Available options:

ASC,

DESC

Response

Successful Response

string

required

url

string

required

@type

string

default:@quintoandar_listing

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[]

/quintoandar/properties /quintoandar/properties/similar