# Batdongsan — 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 property listings for sale or rent across Vietnam's largest real estate marketplace, view detailed property information, explore development projects, and stay updated with the latest real estate news. Access comprehensive real estate data including property specifics, project details, and market insights all in one place.

**Category:** Real Estate | **Website:** [batdongsan.com.vn/](https://batdongsan.com.vn/) | **Docs:** [parse.bot/marketplace/5bc3a4ea-2a97-47c7-849d-76afee22db35/batdongsan-com-vn-api](https://parse.bot/marketplace/5bc3a4ea-2a97-47c7-849d-76afee22db35/batdongsan-com-vn-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-batdongsan-com-vn-api-5bc3a4ea/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_listing_detail

Get full details of a specific listing on batdongsan.com.vn, including property specifications, agent information, images, and location breadcrumbs. The URL should be obtained from search_listings_for_sale or search_listings_for_rent results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL of the listing detail page on batdongsan.com.vn (e.g. from search_listings_for_sale results). |

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

### get_news

Get latest real estate news articles from batdongsan.com.vn. Returns paginated article listings with title, URL, and optional summary.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-batdongsan-com-vn-api-5bc3a4ea/get_news \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>"}'
```

### list_projects

List real estate development projects on batdongsan.com.vn. Returns paginated project listings with title, URL, and address.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-batdongsan-com-vn-api-5bc3a4ea/list_projects \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>"}'
```

### search_listings_for_rent

Search for real estate listings for rent on batdongsan.com.vn. Returns paginated results with listing summaries including price, area, and location. Results are ordered by recency. Each page returns up to 30 listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `keyword` | string | No | Search keyword to filter listings. Omitting returns all listings. |
| `location` | string | No | Location slug for filtering by city/province (e.g. 'ha-noi', 'tp-hcm', 'da-nang'). Omitting returns listings nationwide. |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-batdongsan-com-vn-api-5bc3a4ea/search_listings_for_rent \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"keyword":"<string>","location":"<string>","page":"<integer>"}'
```

### search_listings_for_sale

Search for real estate listings for sale on batdongsan.com.vn. Returns paginated results with listing summaries including price, area, and location. Results are ordered by recency. Each page returns up to 30 listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `keyword` | string | No | Search keyword to filter listings (e.g. 'Vinhomes'). Omitting returns all listings. |
| `location` | string | No | Location slug for filtering by city/province (e.g. 'ha-noi', 'tp-hcm', 'da-nang'). Omitting returns listings nationwide. |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-batdongsan-com-vn-api-5bc3a4ea/search_listings_for_sale \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"keyword":"<string>","location":"<string>","page":"<integer>"}'
```