# Dot Property Search API Documentation

<p><strong>Dot Property Search API</strong> returns Thai homes for sale or for rent as JSON. Filter by location, price, bedrooms, bathrooms, price per square metre, property type, project, agent, pets, views, features and who listed the home, sort the results, and page through up to 333 pages. Each item carries the title, headline, description, sale and rent price in THB, price per sqm, rooms, area, address, region, city and district, coordinates, project, photos, new and sold flags and the verification date. The response also returns the real page, the total pages and results, the applied filters, the location breadcrumb and the sort options. Every returned item satisfies every requested filter; <code>meta.dropped</code> counts rows removed for breaking one. A known location with no matches is a successful empty result. An unknown location returns 404 and a page beyond the last page returns 422.</p>

- **Documentation:** [https://scrappa.co/docs/dotproperty-api/dotproperty_search](https://scrappa.co/docs/dotproperty-api/dotproperty_search)
- **API group:** Dot Property API
- **Endpoint:** `GET https://scrappa.co/api/dotproperty/v1/search`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `transaction_type` | string | No | sale (default) or rent. Example: rent. |
| `location` | string | No | Location slug from the Autocomplete route, for example bangkok, bangkok/watthana or chonburi/pattaya. An unknown location returns 404. Example: bangkok. |
| `property_type` | array | No | One or more of condos, apartments, penthouses, houses, villas, townhouses, land, private-island, commercial-property, offices, retail-spaces, shophouse, warehouses, hotels, whole-building, serviced-apartments. Repeat the parameter (property_type[]=condos) for several. Default: all types. Example: condos. |
| `min_price` | number | No | Minimum price in THB (rent: per month). Example: 3000000. |
| `max_price` | number | No | Maximum price in THB (rent: per month). Must be at least min_price. Example: 6000000. |
| `bedrooms` | integer | No | Exact number of bedrooms, 0 for a studio. Cannot be combined with min_bedrooms or max_bedrooms. Example: 2. |
| `min_bedrooms` | integer | No | Minimum number of bedrooms. Example: 2. |
| `max_bedrooms` | integer | No | Maximum number of bedrooms. Example: 4. |
| `bathrooms` | integer | No | Exact number of bathrooms. Cannot be combined with min_bathrooms or max_bathrooms. Example: 2. |
| `min_bathrooms` | integer | No | Minimum number of bathrooms. Example: 2. |
| `max_bathrooms` | integer | No | Maximum number of bathrooms. Example: 3. |
| `min_price_per_sqm` | number | No | Minimum price per square metre in THB. Example: 80000. |
| `max_price_per_sqm` | number | No | Maximum price per square metre in THB. Example: 150000. |
| `project_id` | integer | No | Project id from the Autocomplete route (projects). Example: 4745. |
| `agent_id` | string | No | Agent or agency uuid from the Agents route. Returns the listings of that publisher. Example: 00000000-ffff-4047-8001-000000000000. |
| `pets` | string | No | dog or cat: only listings that allow the pet. Example: dog. |
| `views` | array | No | One or more of sea, mountain, golf_park, lake_river. Every selected view must match. Example: sea. |
| `features` | array | No | One or more of private_pool, pool_access, jacuzzi, sauna, private_garden, private_gym, duplex, corner_unit, beachfront, beach_access. Every selected feature must match. Example: private_pool. |
| `listed_by` | string | No | owner, agent or developer. Example: owner. |
| `sort` | string | No | rank, verification_at (newest), price, living_area, rate_sqm (price per sqm), bedrooms or bathrooms. Needs order. Rentals sort by rank, verification_at or price only. Example: price. |
| `order` | string | No | asc or desc. Required with sort. Example: asc. |
| `page` | integer | No | One-based page number, 1 to 333 (30 results per page, about 10,000 results per search). A page past the last page returns 422. Example: 2. |

## Example response

```json
{
    "data": {
        "items": [
            {
                "id": 1635622,
                "area": {
                    "sqm": 62,
                    "label": "62 SqM"
                },
                "sold": null,
                "uuid": "bde24b178f86-74ee-97c2-0030-c0796089",
                "price": {
                    "rent": {
                        "value": null,
                        "period": "month",
                        "formatted": null
                    },
                    "sale": {
                        "value": 7890000,
                        "formatted": "\u0e3f7,890,000"
                    },
                    "currency": "THB"
                },
                "title": "Taka Haus Ekamai 12",
                "images": [
                    {
                        "url": "https://cdn.fazwaz.com/wbr/3uIF94YV3jwpbrblqX803Y5iy2A/576x384/unit/1635622/img-6922-japandi-warm.png",
                        "sizes": "(min-width: 1200px) 576px, (min-width: 390px) 377px, (max-width: 360px) 360px, 576px"
                    },
                    {
                        "url": "https://cdn.fazwaz.com/wbr/z9xMzjJ_AdQwRZ_Gwp1hTQyWHGQ/576x384/unit/1635622/img-6923-japandi-warm.png",
                        "sizes": "(min-width: 1200px) 576px, (min-width: 390px) 377px, (max-width: 360px) 360px, 576px"
                    }
                ],
                "address": "Khlong Tan Nuea, Watthana, Bangkok",
                "is_sold": false,
                "project": {
                    "name": "Taka Haus Ekamai 12",
                    "slug": "taka-haus-ekamai-12"
                },
                "bedrooms": 2,
                "headline": "Stylish Boutique 2BR Condo in Prime Ekkamai | Near Big C & Gateway | Now Reduced to THB 7.89M",
                "location": {
                    "city": "watthana",
                    "slug": "bangkok/watthana",
                    "level": null,
                    "region": "bangkok",
                    "district": "khlong-tan-nuea"
                },
                "bathrooms": 2,
                "thumbnail": "https://cdn.fazwaz.com/wbr/1J_vIaveZAsdVKuwc_71JKsCQnw/374x249/unit/1635622/img-6922-japandi-warm.png",
                "coordinates": {
                    "lat": 13.7289228,
                    "lng": 100.5916445
                },
                "description": "Enjoy space for living, working and unwinding at Taka Haus Ekkamai 12. This 2-bedroom condo combines a quieter residential setting with convenient acc...",
                "verified_at": "2024-11-06T14:17:18+07:00",
                "price_per_sqm": {
                    "value": 127258,
                    "formatted": "\u0e3f127,258/SqM"
                },
                "property_type": {
                    "code": "condo",
                    "name": "Condo"
                },
                "bedrooms_label": "2 Beds",
                "is_new_listing": false,
                "bathrooms_label": "2 Baths"
            },
            {
                "id": 1121298,
                "area": {
                    "sqm": 76,
                    "label": "76 SqM"
                },
                "sold": null,
                "uuid": "9356a127d3f1-287f-5126-78f6-c43dea06",
                "price": {
                    "rent": {
                        "value": 22000,
                        "period": "month",
                        "formatted": "\u0e3f22,000"
                    },
                    "sale": {
                        "value": 7477000,
                        "formatted": "\u0e3f7,477,000"
                    },
                    "currency": "THB"
                },
                "title": "Baan Siri Sukhumvit 13",
                "images": [
                    {
                        "url": "https://cdn.fazwaz.com/wbr/_zV2y5cUewIY8_8yVAd-4EQ8uwY/576x384/unit/1121298/296923.jpg",
                        "sizes": "(min-width: 1200px) 576px, (min-width: 390px) 377px, (max-width: 360px) 360px, 576px"
                    },
                    {
                        "url": "https://cdn.fazwaz.com/wbr/I_f_BH4RymPcDbxIywc8klDex_0/576x384/unit/1121298/296924.jpg",
                        "sizes": "(min-width: 1200px) 576px, (min-width: 390px) 377px, (max-width: 360px) 360px, 576px"
                    }
                ],
                "address": "Khlong Toei Nuea, Watthana, Bangkok",
                "is_sold": false,
                "project": {
                    "name": "Baan Siri Sukhumvit 13",
                    "slug": "baan-siri-sukhumvit-13"
                },
                "bedrooms": 2,
                "headline": "City-View 2BR Condo in Prime Sukhumvit 13 | 7.69% Below Market Price",
                "location": {
                    "city": "watthana",
                    "slug": "bangkok/watthana",
                    "level": null,
                    "region": "bangkok",
                    "district": "khlong-toei-nuea"
                },
                "bathrooms": 2,
                "thumbnail": "https://cdn.fazwaz.com/wbr/OJLCLQtaxZvHKt4tgXMqi3GRY5M/374x249/unit/1121298/296923.jpg",
                "coordinates": {
                    "lat": 13.7477597,
                    "lng": 100.5580163
                },
                "description": "A spacious 2-bedroom condo at Baan Siri Sukhumvit 13, located in the heart of the Nana\u2013Asoke area. This prime Sukhumvit 13 address offers convenient a...",
                "verified_at": "2022-07-12T09:02:50+07:00",
                "price_per_sqm": {
                    "value": 98382,
                    "formatted": "\u0e3f98,382/SqM"
                },
                "property_type": {
                    "code": "condo",
                    "name": "Condo"
                },
                "bedrooms_label": "2 Beds",
                "is_new_listing": false,
                "bathrooms_label": "2 Baths"
            }
        ],
        "location": {
            "name": "Watthana, Bangkok",
            "breadcrumb": [
                {
                    "path": "/",
                    "title": "Home"
                },
                {
                    "path": "/condos-for-sale",
                    "title": "Condo For Sale"
                },
                {
                    "path": "/condos-for-sale/bangkok",
                    "title": "Bangkok"
                }
            ]
        },
        "pagination": {
            "max_page": 333,
            "per_page": 30,
            "total_pages": 19,
            "current_page": 1,
            "has_next_page": true,
            "total_results": 557
        },
        "sort_options": [
            {
                "sort": "rank",
                "order": "asc",
                "title": "Recommended"
            },
            {
                "sort": "verification_at",
                "order": "desc",
                "title": "Newest"
            },
            {
                "sort": "price",
                "order": "asc",
                "title": "Price (low to high)"
            }
        ],
        "applied_filters": {
            "location": "bangkok/watthana",
            "max_price": 8000000,
            "min_bedrooms": 2,
            "property_type": [
                "condos"
            ],
            "transaction_type": "sale"
        }
    },
    "meta": {
        "dropped": 0,
        "billable": true,
        "endpoint_family": "search"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A parameter or a range is invalid, or the page is beyond the last page. This response is not billable. |
| 404 | Not Found | The location does not exist. Use the Autocomplete route to find a valid location. This response is not billable. |
| 503 | Upstream Unavailable | Dot Property could not be reached or returned data that does not match the request. This response is not billable and is retryable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
