# Olx (Brazil) — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and browse OLX Brazil real estate listings for properties available for sale or rent, with advanced filtering options to narrow down your search. Access comprehensive property details including descriptions, prices, locations, and other key information for each listing.

**Category:** Real Estate | **Website:** [olx.com.br/](https://olx.com.br/) | **Docs:** [parse.bot/marketplace/70010afe-86d6-428e-80e1-e81a0084314b/olx-com-br-api](https://parse.bot/marketplace/70010afe-86d6-428e-80e1-e81a0084314b/olx-com-br-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-olx-com-br-api-70010afe/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_listing_detail

Get full details for a single OLX real estate listing by its URL. Returns comprehensive property information including description, specs, images, location, and advertiser details. The URL is obtained from search results items.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL of the OLX listing (obtained from search results url field). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-olx-com-br-api-70010afe/get_listing_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### search_by_keyword

Search for real estate properties using a free-text keyword. Searches across all property types for sale. Returns paginated results matching the keyword with the same item shape as other search endpoints.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword (e.g. 'casa com piscina', 'apartamento mobiliado'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-olx-com-br-api-70010afe/search_by_keyword \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### search_real_estate_for_rent

Search for real estate properties for rent in Brazil. Returns paginated results with property summaries including title, price, location, and basic specs. Paginates via integer page number. Each item includes a URL that can be passed to get_listing_detail for full property information.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bathrooms` | integer | No | Minimum number of bathrooms. |
| `bedrooms` | integer | No | Minimum number of bedrooms. |
| `location` | string | No | Location path segment for filtering by region (e.g. 'sp', 'rj', 'sp/grande-sao-paulo'). |
| `max_area` | integer | No | Maximum area in square meters. |
| `max_price` | integer | No | Maximum price in BRL. |
| `min_area` | integer | No | Minimum area in square meters. |
| `min_price` | integer | No | Minimum price in BRL. |
| `page` | integer | No | Page number for pagination. |
| `property_type` | string | No | Type of property to search for. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-olx-com-br-api-70010afe/search_real_estate_for_rent \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bathrooms":"<integer>","bedrooms":"<integer>","location":"<string>","max_area":"<integer>","max_price":"<integer>","min_area":"<integer>","min_price":"<integer>","page":"<integer>","property_type":"<string>"}'
```

### search_real_estate_for_sale

Search for real estate properties for sale in Brazil. Returns paginated results with property summaries including title, price, location, and basic specs. Paginates via integer page number. Each item includes a URL that can be passed to get_listing_detail for full property information.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bathrooms` | integer | No | Minimum number of bathrooms. |
| `bedrooms` | integer | No | Minimum number of bedrooms. |
| `location` | string | No | Location path segment for filtering by region (e.g. 'sp', 'rj', 'sp/grande-sao-paulo'). |
| `max_area` | integer | No | Maximum area in square meters. |
| `max_price` | integer | No | Maximum price in BRL. |
| `min_area` | integer | No | Minimum area in square meters. |
| `min_price` | integer | No | Minimum price in BRL. |
| `page` | integer | No | Page number for pagination. |
| `property_type` | string | No | Type of property to search for. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-olx-com-br-api-70010afe/search_real_estate_for_sale \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bathrooms":"<integer>","bedrooms":"<integer>","location":"<string>","max_area":"<integer>","max_price":"<integer>","min_area":"<integer>","min_price":"<integer>","page":"<integer>","property_type":"<string>"}'
```