# /quintoandar/properties/search

`POST /api/quintoandar/properties/search`

Price: 1 credit

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.

## How to use it

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.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `location` (string, required) — City slug, e.g. 'sao-paulo-sp-brasil' or 'rio-de-janeiro-rj-brasil' (examples: "sao-paulo-sp-brasil"; minLength: 1)
- `business_context` (string) — Rent or sale listings (default: "RENT"; one of: "RENT", "SALE")
- `price_min` (integer, nullable) — Minimum price in BRL (min: 0)
- `price_max` (integer, nullable) — Maximum price in BRL (min: 0)
- `price_type` (string, nullable) — Which price the price_min/price_max range applies to. Defaults to monthly rent for rent listings and sale price for sale listings (one of: "RENT_PRICE", "TOTAL_COST", "SALE_PRICE")
- `house_type` (array, nullable) — Property type filter (one of: "APARTMENT", "HOUSE", "HOUSE_CONDO", "STUDIO")
- `area_min` (integer, nullable) — Minimum floor area in m2 (min: 0)
- `area_max` (integer, nullable) — Maximum floor area in m2 (min: 0)
- `bedrooms_min` (integer, nullable) — Minimum number of bedrooms (min: 1)
- `bathrooms_min` (integer, nullable) — Minimum number of bathrooms (min: 1)
- `parking_min` (integer, nullable) — Minimum number of parking spaces (min: 1)
- `suites_min` (integer, nullable) — Minimum number of suites (min: 1)
- `furnished` (boolean, nullable) — Only furnished or only unfurnished listings
- `accepts_pets` (boolean, nullable) — Only listings that accept pets
- `near_subway` (boolean, nullable) — Only listings near a subway or train station
- `availability` (string) — Availability filter (default: "ANY"; one of: "ANY", "immediate", "soon")
- `amenities` (array, nullable) — Required unit amenities (one of: "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` (array, nullable) — Required building installations (one of: "ACADEMIA", "AREA_VERDE", "BRINQUEDOTECA", "CHURRASQUEIRA", "Elevador", "LAVANDERIA_NO_PREDIO", "PISCINA", "PLAYGROUND", "Porteiro24H", "QUADRA_ESPORTIVA", "SALAO_DE_FESTAS", "SALAO_DE_JOGOS", "SAUNA")
- `accessibility` (array, nullable) — Required accessibility features (one of: "BANHEIRO_ADAPTADO", "CORRIMAO", "PISO_TATIL", "QUARTOS_E_CORREDORES_COM_PORTAS_AMPLAS", "RAMPAS_DE_ACESSO", "VAGA_DE_GARAGEM_ACESSIVEL")
- `sort_by` (string) — Sort criteria (default: "RELEVANCE"; one of: "RELEVANCE", "TOTAL_COST", "SALE_PRICE", "RENT_VALUE")
- `sort_order` (string) — Sort direction (default: "DESC"; one of: "ASC", "DESC")
- `count` (integer, required) — Max number of listings to return (min: 1)

## Response

### 200 — Successful Response

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

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

No matching city/location found for the given slug

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.