Search Properties

Free-text search across the property index, including address, neighborhood, city, code, and description. Use this for a free-form phrase or a city without a neighborhood. Do not combine it with property_address or neighborhood.

Exact public property code. Preserve the complete value, for example AP-001.

Partial or complete street address, with or without a number. Use it for a logradouro such as 'Avenida Paulista', 'Av. Paulista, 1000', or 'Rua Augusta, 200'. Do not also send search_text.

Property status filter: available, pending, rented, reserved, solded, with_proposal, solded_by_third_parties, rented_by_third_parties, or suspended.

Transaction filter. Map 'comprar', 'compra', 'venda', or 'à venda' to buy; 'alugar', 'aluguel', or 'locação' to rent; and 'temporada' or 'diária' to vacation_rental. Omit this field when the user provides only a monetary value, so value searches sale and rental prices. The value filter is not applied with vacation_rental.

Usage classification: residential, commercial, or rural. Send it only when the user states the finality; do not infer it during search because incorrectly classified records could be excluded.

Property type from the account-specific catalog, for example 'Apartamento', 'Casa de Condomínio', or 'Chácara'. The tool accepts registered labels, normalized names, and common Portuguese or English aliases. An unknown type returns the available registered options before the search is executed.

Preconfigured property list: all, available, my_properties, site_publish, site_no_publish, pending, inactives, without_photos, reserved, rented, solded, vacation_rental, sale, rent, or without_location. Use my_properties for 'meus imóveis'; use site_publish for 'publicados no site'.

Set to true when the user refers to their own properties using self-referential language: 'meus imóveis', 'minha carteira de imóveis', 'imóveis que eu tenho', or 'meus apartamentos'. When no explicit smart_list is provided, true is equivalent to smart_list='my_properties'. An explicit smart_list takes precedence. Do not use this for another broker, such as 'imóveis do corretor João'.

Neighborhood name, for example 'Santo Amaro', 'Pinheiros', or 'Ipanema'. Use property_address for a street or avenue. When city is also provided, the tool searches the combined neighborhood and city text. Do not also send search_text.

City used together with neighborhood, for example 'São Paulo' or 'Curitiba'. The structured search does not apply city by itself; for a city-only request, put the city in search_text.

Minimum number of bedrooms. Map 'apartamento com 2 dormitórios', 'a partir de 2 quartos', or 'pelo menos 2 quartos' to bedroom_min=2.

Maximum number of bedrooms. Combine with bedroom_min for a range. For 'exatamente 2 quartos', set both bedroom_min and bedroom_max to 2.

Minimum number of suites. Map 'pelo menos 1 suíte' or 'de preferência uma suíte' to suite_min=1.

Maximum number of suites. Combine with suite_min to define a range.

Minimum number of bathrooms. Use for requests such as 'com 2 banheiros' or 'pelo menos 2 banheiros'.

Minimum number of parking spaces. Use for requests such as '2 vagas de garagem' or 'com garagem'.

Minimum unit floor. Map 'acima do 15º andar' to floor_min=16 and 'a partir do 10º andar' to floor_min=10.

Maximum unit floor. Map 'até o 5º andar' to floor_max=5.

Maximum monetary value. With interest='buy', applies sale_value <= value; with interest='rent', applies rental_value <= value; without interest, accepts either positive sale_value or rental_value up to this ceiling. A lower-bound price request is not supported. This filter is not applied to vacation_rental.

Name of a specific listing broker used to filter properties. For the requesting user's own properties, use requesting_user_only=true.

Email of a specific listing broker used for a more precise filter. For the requesting user's own properties, use requesting_user_only=true.

Maximum number of properties per page. Defaults to 10; allowed range is 1 to 50.

Cursor returned by the previous search response for the next page.