olx.com.br APIolx.com.br ↗
Search OLX Brazil property listings for sale and rent. Filter by price, location, bedrooms, and area. Retrieve full listing details including specs and advertiser info.
curl -X GET 'https://api.parse.bot/scraper/bf7032e5-846c-4e0e-a461-76d9559e9e73/search_real_estate_for_sale?page=1&location=sp&property_type=casas' \ -H 'X-API-Key: $PARSE_API_KEY'
Search for real estate properties for sale in Brazil. Returns paginated results with property summaries including title, price, location, and basic specs.
| Param | Type | Description |
|---|---|---|
| page | integer | Page number for pagination. |
| bedrooms | integer | Minimum number of bedrooms. |
| location | string | Location path segment for filtering by region (e.g. 'sp', 'rj', 'sp/grande-sao-paulo'). |
| max_area | integer | Maximum area in square meters. |
| min_area | integer | Minimum area in square meters. |
| bathrooms | integer | Minimum number of bathrooms. |
| max_price | integer | Maximum price in BRL. |
| min_price | integer | Minimum price in BRL. |
| property_type | string | Type of property: casas, apartamentos, terrenos, comercial, quartos. |
{
"type": "object",
"fields": {
"page": "integer current page number",
"items": "array of property listing summaries with title, price, listId, url, location, date, images, category, is_professional, area, rooms, bathrooms, garage",
"total": "integer total number of matching listings"
},
"sample": {
"data": {
"page": 1,
"items": [
{
"url": "https://sp.olx.com.br/sao-paulo-e-regiao/imoveis/sobrado-76m-2-dormitorios-2-vagas-chacara-faggion-suzano-944761107",
"area": "76m²",
"date": 1778762102,
"price": "R$ 460.000",
"rooms": "2",
"title": "Sobrado 76m² 2 Dormitórios 2 vagas",
"garage": "2",
"images": [
"https://img.olx.com.br/images/74/746694365701529.jpg"
],
"listId": 944761107,
"category": "Casas",
"location": "Suzano - SP",
"bathrooms": "2",
"is_professional": true
}
],
"total": 1848580
},
"status": "success"
}
}About the olx.com.br API
This API provides access to OLX Brazil real estate data across 4 endpoints, covering property search for sale and rent, keyword-based discovery, and full listing details. The get_listing_detail endpoint returns structured specs (bedrooms, bathrooms, parking, total area, useful area), advertiser contact information, and the full property description, all from a single listing URL.
Search and Filter Listings
The search_real_estate_for_sale and search_real_estate_for_rent endpoints return paginated arrays of property summaries. Both accept the same filter set: location (a path segment such as 'sp', 'rj', or 'sp/grande-sao-paulo'), min_price and max_price in BRL, min_area and max_area in square meters, and minimum bedrooms and bathrooms counts. Each item in the returned items array includes title, price, listId, url, location, date, images, category, is_professional, area, and rooms. The total field gives the full match count across all pages.
Keyword Search
The search_by_keyword endpoint accepts a free-text query parameter — for example 'casa com piscina' or 'apartamento mobiliado' — and returns matching listings across all for-sale property types. The response shape is identical to the structured search endpoints, giving the same items summary array and total count. This endpoint is useful when users have specific feature requirements that don't map neatly to the available filter parameters.
Full Listing Detail
Passing a listing URL from any search result to get_listing_detail returns the complete property record. The specs object contains bedrooms, bathrooms, parking, total_area, and useful_area. The location object breaks down into address, neighbourhood, city, state, and zipcode. The advertiser object includes the seller's name, type (professional or particular), and phone. The description field delivers the full property description with HTML formatting preserved.
- Build a property price index for Brazilian cities by aggregating
min_price/max_pricefiltered results across regions. - Monitor new rental listings in a specific neighbourhood using
search_real_estate_for_rentwith alocationpath and polling bydate. - Enrich a CRM with advertiser contact details and property specs by feeding listing URLs into
get_listing_detail. - Identify professional vs. private sellers in a market segment using the
is_professionalflag returned in search results. - Power a property recommendation engine with keyword-based search via
search_by_keywordusing natural-language queries. - Aggregate listing images and descriptions for a real estate content platform using the
imagesarray anddescriptionfield fromget_listing_detail. - Compare area-to-price ratios across Brazilian states by combining
min_area/max_areafilters withlocationacross multiple search calls.
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 250 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does OLX Brazil have an official developer API?+
What does the `location` parameter accept in the search endpoints?+
location parameter takes a path segment string matching OLX Brazil's regional URL structure. Accepted values include broad state codes like 'sp' or 'rj', as well as sub-regional paths such as 'sp/grande-sao-paulo'. Listings are filtered to the specified region. There is no geocoordinate or bounding-box filter currently.Does the API return commercial properties or only residential real estate?+
Is there a limit to how many pages of results I can retrieve?+
page parameter and a total count, allowing you to paginate through results. In practice, OLX Brazil limits how deep into results pages are accessible — very high page numbers may return empty or truncated results depending on the query and filter combination. The total field reflects the count reported by the source, not the number of pages guaranteed to be retrievable.