# Imovelweb — 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 detailed real estate listings on imovelweb.com.br by city, state, and neighborhood. Retrieve structured property data including pricing, size, room counts, features, and full listing descriptions — ready for analysis, comparison, or portfolio tracking.

**Category:** Real Estate | **Website:** [imovelweb.com.br/](https://imovelweb.com.br/) | **Docs:** [parse.bot/marketplace/03f7e175-cf7d-4083-bf7b-65daf2a11782/imovelweb-com-br-api](https://parse.bot/marketplace/03f7e175-cf7d-4083-bf7b-65daf2a11782/imovelweb-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-imovelweb-com-br-api-03f7e175/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_listing_details

Fetch full details for a specific listing including the complete text description and structured property features. The url parameter is a listing page URL obtained from search_apartments results. Returns 404/410 as stale_input when the listing has been removed.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full listing detail page URL from imovelweb.com.br (obtained from search_apartments results[*].url). |

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

### search_apartments

Search for apartments for sale on Imovelweb by location (neighborhood, city, state). Returns paginated listing summaries with price, location, features, and detail-page URLs. Each page returns up to ~30 results. Pagination advances via the page parameter. When no listings match, returns an empty array.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name. |
| `neighborhood` | string | No | Neighborhood name. Accents are normalized automatically (e.g. 'juveve' for Juvevê). |
| `page` | integer | No | Page number for pagination (1-based). |
| `state` | string | No | State name. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-imovelweb-com-br-api-03f7e175/search_apartments \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","neighborhood":"<string>","page":"<integer>","state":"<string>"}'
```